(PR65) Docs/Document Views - #191
Open
nikolaredstork wants to merge 21 commits into
Open
Conversation
GuillaumeMaistre
added
documentation
This was
linked to
issues
Jul 3, 2026
GuillaumeMaistre
changed the title
aoustry
requested changes
Jul 15, 2026
aoustry
left a comment
aoustry
left a comment
Collaborator
There was a problem hiding this comment.
Minor changes requested.
Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
aoustry
reviewed
Jul 23, 2026
* update domains concenring views * document views inside the table * mention views inside glossary * restructure table * rename groups by categories * use new architecture diagram * integrate the data workflow inside the file structure page * Update doc/overview/glossary.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/overview/file-structure.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/overview/file-structure.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/overview/glossary.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * move the data workflow section * update diagram architectural overview * upate diagram * Update taxonomy description in file structure --------- Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
* create taxonomy file * rename taxonomy example * use antares legacy lib * update taxonomy based on the library example * delete views builder mentions * apply suggestions * add link to the models * refactor & move the table * delete logo header
* creation of catalog file * mention new pages into mkdocs * add links between every page * change notebox to infobox * catalog made by antares legacy example * update link to legacy library * rephrase intro * delete logo headers * update example based on the taxonomy example file * move definition table * refactor definition table * Update doc/user-guide/input-files/catalog.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/user-guide/input-files/catalog.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/user-guide/input-files/catalog.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/user-guide/input-files/catalog.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Update doc/user-guide/input-files/catalog.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * deletion of legacy mention * mention the taxonomy file but WITHOUT its link * add subsections for the catalog structure description * define terms * clarify terms definition * add link to the antares legacy taxonomy * Apply suggestion from @aoustry --------- Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
* reformat vew-config * add links * mention view config files in mkdocs * add catalog but with an under construction label * change notebox * delete catalog * delete mention of catalog file * update example of view config based on antares legacy libs * refresh titles and use md title marks based on suggestions * deletion of "yml" to refer to all files * deletion of yml for mentionning view_config & add link to outputs/views page * fix typo about *_* format * fix syntax of Views writting
* update mermaid diagram * update views output explanations file * update links mentionning views file * changing phrasing and add note * change notebox * delete builder mention * adapt diagram to darkmode * delete logo * Update doc/user-guide/outputs/view.md Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com> * Views with an upper case and in plural * deletion of yml particle for files * refresh phrasing * add column type * rename views md file * fix files renamming * delete double md * rename section * add catalog file * fix links * delete duplicated line * fix links * file structure -> input files * fix typos --------- Co-authored-by: Antoine Oustry, PhD <58943406+aoustry@users.noreply.github.com>
GuillaumeMaistre
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Process ID
Process:
DOC-02
Description
This PR renames folder userguide/files-structure by userguide/input-files
The links from the pages to the ones inside the userguide are also updated
Others PRs of Views Builder will be merged inside this one, as its file structure defines the architecture of the others
Impact Analysis
none
Checklist
library.versioninlibraries/<library>.yml)libraries/CHANGELOG-<library>.md)doc/0_Home/4_release_notes.md)COMPATIBILITY.md)AGENTS.mdreviewed for impact and updated if needed