Repository navigation
Integrate public engineering documentation and report templates - #3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Integrates public-facing engineering documentation and a versioned report-template library into AIMORAResources, along with a documentation/content gate intended to enforce public/private boundaries and basic inventory integrity.
Changes:
- Adds v1 declarative report templates plus a manifest and usage documentation for professional reporting.
- Introduces/expands core professional manual pages (study/model/solver/reporting references, glossary, troubleshooting, coverage rules) and updates Documenter navigation.
- Adds a public “complete semantic reporting” example descriptor and a Julia
docs/check_content.jlgate for manual/case/template/link audits.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| report-templates/v1/transformer-parameters.toml | Adds transformer-parameter conversion report template metadata and required sections. |
| report-templates/v1/research-reproducible.toml | Adds a reproducibility-oriented research report template with reproducibility requirements. |
| report-templates/v1/qualification.toml | Adds a validation/qualification evidence report template and required evidence fields. |
| report-templates/v1/manifest.toml | Introduces the v1 template inventory manifest listing all shipped templates. |
| report-templates/v1/line-cable-constants.toml | Adds a line/cable constants reporting template with required constants/geometry items. |
| report-templates/v1/engineering-standard.toml | Adds a general engineering reporting template and document-control requirements. |
| report-templates/v1/emt-study.toml | Adds an EMT study reporting template with required EMT metadata. |
| report-templates/v1/education-laboratory.toml | Adds an education/laboratory reporting template with learning objective requirements. |
| report-templates/v1/combined-study.toml | Adds a combined cross-study template requiring a dependency DAG and consolidation sections. |
| report-templates/PROFESSIONAL_REPORTING.md | Documents the report template library, trust boundary, and validation rules. |
| README.md | Updates repository map, documentation entrypoint, commands, and public boundary/licensing notes. |
| examples/reporting/complete_report/README.md | Documents the complete semantic reporting fixture and its claim boundary. |
| examples/reporting/complete_report/case.toml | Adds a machine-readable public case descriptor for the reporting example outputs and provenance IDs. |
| docs/src/troubleshooting.md | Adds troubleshooting guidance across workspace, solver, parsing, convergence, reporting, and docs checks. |
| docs/src/study-reference.md | Adds implemented vs planned study catalogue reference and common execution contract. |
| docs/src/source-coverage.md | Defines documentation/content gate scope, rules, and mandatory pages list. |
| docs/src/solver-reference.md | Documents solver activation, capability contracts, restart behavior, and diagnostics. |
| docs/src/results-and-reporting.md | Documents result identity, semantic reporting model, QA rules, and publication lifecycle. |
| docs/src/professional-manual.md | Adds the professional manual entrypoint and workflow-driven navigation map. |
| docs/src/model-reference.md | Adds accepted and planned model-family reference with limitations and status boundaries. |
| docs/src/glossary.md | Adds terminology definitions for public documentation and reporting concepts. |
| docs/src/example-catalog.md | Documents case catalogue contract, run commands, and acceptance/audit requirements. |
| docs/src/deck-card-reference.md | Adds deck parsing and validation rules plus card-family overviews. |
| docs/src/architecture-reference.md | Documents repository ownership split and the public/private solver boundary. |
| docs/make.jl | Reworks Documenter navigation into structured sections and updates repository/canonical configuration. |
| docs/check_content.jl | Adds a documentation/content gate script to audit manual pages, cases, templates, and links. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+91
to
+92
| for key in ("id", "version", "licence", "family", "required_roles", "output_profiles") | ||
| haskey(template, key) || push!(errors, "$id template is missing field '$key'") |
Comment on lines
+105
to
+111
| target = split(match.captures[1], '#'; limit = 2)[1] | ||
| isempty(target) && continue | ||
| any(prefix -> startswith(target, prefix), ("http://", "https://", "mailto:", "#")) && | ||
| continue | ||
| target_path = normpath(joinpath(docs_root, target)) | ||
| ispath(target_path) || push!(errors, "$page has broken local link: $target") | ||
| end |
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.
Integrates the complete commit history of #1 onto the organization main line, resolves documentation navigation against all currently accepted science pages, removes branch-only restoration automation/status artifacts, prevents public private-repository disclosure, labels planned surge/protection/converter families instead of claiming availability, and fixes the executable content audit. Local verification: public documentation check PASS; content gate 102 cases/8 templates/11 manual pages PASS with 38 existing provenance omissions reported; Documenter build PASS; report templates 3/3; Resources repository/licence/privacy contracts 75/75.