Support documentation#357
Open
vanmeerkerk wants to merge 11 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates project support guidance and refines the documentation structure by consolidating Intro and Network conceptual material into single, more comprehensive pages. It also adds an explicit documentation AI-assistance disclosure in the Sphinx footer.
Changes:
- Add/standardize end-user support routing to
Project-OMOTES/user_feedback(README, Support page, CONTRIBUTING, and internal doc-agent guidance). - Consolidate Intro content into
doc/intro/intro_main.rstand expanddoc/network/network_main.rstinto a single, detailed Network page; remove the former Intro subpages. - Add a Sphinx HTML template override to include an AI-assistance disclosure in the docs footer.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a Support section pointing users to the external user_feedback repo. |
| doc/support/support.rst | Expands and clarifies support paths (Discussions vs Issues; user vs contributor flows). |
| doc/solver/solver_convergence.rst | Updates Related Documentation link to the consolidated Intro page. |
| doc/network/network_main.rst | Rewrites/expands Network docs into a single-page structure (representation, construction, partitioning, rules, assumptions). |
| doc/intro/simulation_input_and_output.rst | Removes old Intro subpage (content moved into consolidated intro_main). |
| doc/intro/package_scope.rst | Removes old Intro subpage (content moved into consolidated intro_main). |
| doc/intro/audience_and_use_cases.rst | Removes old Intro subpage (content moved into consolidated intro_main). |
| doc/intro/intro_main.rst | Expands Intro into a consolidated single page (overview, scope, why-used, example, related links). |
| doc/_templates/page.html | Adds footer disclosure about generative-AI assistance in documentation. |
| CONTRIBUTING.md | Redirects end-user support requests to the external user_feedback repo and points to docs. |
| .github/instructions/documentation-architecture.instructions.md | Updates internal documentation architecture guidance for support paths and external templates. |
| .github/agents/SystemConceptDocAgent.agent.md | Updates agent guidance: Intro and Network as single consolidated pages with required structure. |
| .github/agents/SupportDocAgent.agent.md | Updates agent guidance for support routing and confirmed external templates. |
| .github/agents/DocumentationCoordinator.agent.md | Updates internal routing taxonomy and decision rules for Intro/Network consolidation. |
| .github/agents/DocReviewAgent.agent.md | Updates review rules to reflect consolidated Network page intent and structure. |
MichielTukker
requested changes
Jun 29, 2026
MichielTukker
left a comment
MichielTukker
left a comment
Contributor
There was a problem hiding this comment.
The agent made some weird edits, please check and update
Comment on lines
+138
to
+139
| - Only ESDL assets with state ``ENABLED`` are included in the network; disabled assets | ||
| are silently skipped during construction. |
Contributor
There was a problem hiding this comment.
What about OPTIONAL assets? (also left out, but not documented?)
| a code-level issue in this repository. | ||
| - Use the conceptual sections (Intro, Solver, Network, Physics, Control) or Developer | ||
| Documentation instead if you are trying to understand existing behavior or | ||
| implementation rather than report or ask something new. |
Contributor
There was a problem hiding this comment.
Rare zin? vrij vertaal: "Lees de documentatie in plaats van iets te vragen wat er nog niet instaat"?
MichielTukker
approved these changes
Jul 1, 2026
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
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.
No description provided.