Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/agents/APIReferenceAgent.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,9 @@ Before editing reference pages, inspect the existing documentation structure and
``doc/controller/control_behavior.rst`` and ``doc/controller/behavior/*.rst``, the detailed
controller behavior / physical-impact pages owned by ``ControllerBehaviorDocAgent``), and
``doc/solver/*.rst``
and ``doc/solver/assets/*.rst`` (excluding the conceptual trio
``solver_workflow.rst``, ``solver_unknowns_and_equations.rst``, and
``solver_convergence.rst``, and the landing page ``solver_main.rst``, both owned by
``SystemConceptDocAgent``, and excluding ``doc/solver/solver_behavior.rst``, the detailed
solver behavior / physical-impact page owned by ``SolverBehaviorDocAgent``)
and ``doc/solver/assets/*.rst`` (excluding the four-page Solver section
``solver_main.rst``, ``solver_workflow.rst``, ``solver_unknowns.rst``, and
``solver_convergence.rst``, all owned by ``SolverBehaviorDocAgent``)

2. Use source code as the authoritative reference source:
- ``src/omotes_simulator_core/...`` for the target package/module tree
Expand Down
39 changes: 19 additions & 20 deletions .github/agents/DocumentationCoordinator.agent.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
name: DocumentationCoordinator
description: Coordinate documentation work for SIMULATOR-CORE by classifying requests, enforcing the documentation structure, delegating to specialist agents, and validating consistency across pages.
description: '>-'
Coordinate documentation work for SIMULATOR-CORE by classifying requests,: ''
enforcing the documentation structure, delegating to specialist agents, and: ''
validating consistency across pages.: ''
Comment on lines +3 to +6
argument-hint: Documentation goal, affected sections/pages, and scope constraints.
tools: [read, search, edit, execute/runInTerminal, web, agent]
tools: ['read', 'search', 'edit', 'execute/runInTerminal', 'web', 'agent', 'read_file', 'file_search', 'grep_search', 'insert_edit_into_file', 'replace_string_in_file', 'create_file', 'get_terminal_output', 'open_file', 'ask_questions', 'get_errors', 'list_dir', 'validate_cves', 'run_subagent', 'semantic_search', 'run_in_terminal']
agents:
- SystemConceptDocAgent
- PhysicsAssetDocAgent
Expand All @@ -15,16 +18,19 @@ agents:
- DocReviewAgent
- SphinxValidationAgent
handoffs:
- label: "Review for audience/scope/duplication"
- label: Review for audience/scope/duplication
agent: DocReviewAgent
prompt: "Review the page(s) just authored for audience fit, section fit, scope correctness, duplication, and cross-link quality."
prompt: '>-'
Review the page(s) just authored for audience fit, section fit, scope: ''
correctness, duplication, and cross-link quality.: ''
Comment on lines +23 to +25
send: true
- label: "Validate Sphinx build"
- label: Validate Sphinx build
agent: SphinxValidationAgent
prompt: "Validate that the documentation build is clean (toctrees, autodoc resolution, rst syntax) for the page(s) just authored/reviewed."
prompt: '>-'
Validate that the documentation build is clean (toctrees, autodoc: ''
resolution, rst syntax) for the page(s) just authored/reviewed.: ''
Comment on lines +29 to +31
send: true
---

You are a documentation coordination agent.

Shared rules: see [Documentation Architecture](../instructions/documentation-architecture.instructions.md) for the fixed section order, equation/notation rules, and build-validation command.
Expand Down Expand Up @@ -101,19 +107,12 @@ Classify each task into one of the following documentation types:

Solver documentation refinement
--------------------------------
Treat solver documentation as two distinct types:

- Solver conceptual documentation:
short, high-level overview of solver workflow, the unknowns it resolves, and convergence
concepts for users and integrators (``doc/solver/solver_main.rst`` and its three conceptual
pages: ``solver_workflow.rst``, ``solver_unknowns_and_equations.rst``,
``solver_convergence.rst``)

- Solver behavior and physical impact:
detailed explanation of the equation system the solver assembles each timestep (node and asset
mass/energy/pressure-drop equations), the fixed-point iteration and convergence scheme, and how
solving that system changes the solved physical model, at a level of detail comparable to the
physics asset pages (``doc/solver/solver_behavior.rst``)
Treat solver documentation as a single four-page section owned by ``SolverBehaviorDocAgent``:

- ``doc/solver/solver_main.rst`` — overview, role, and the Newton-Raphson linearization statement,
- ``doc/solver/solver_workflow.rst`` — the solve workflow (assemble, solve, check, iterate),
- ``doc/solver/solver_unknowns.rst`` — the solved unknowns (pressure, mass flow, internal energy),
- ``doc/solver/solver_convergence.rst`` — absolute and relative convergence determination.

Control documentation refinement
--------------------------------
Expand Down
Loading
Loading