docs(diagrams): add Mermaid template and architecture metadata headers#2392
Closed
SatoryKono wants to merge 1 commit intomainfrom
Closed
docs(diagrams): add Mermaid template and architecture metadata headers#2392SatoryKono wants to merge 1 commit intomainfrom
SatoryKono wants to merge 1 commit intomainfrom
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Owner
Author
|
Superseded by #2422. |
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.
Motivation
.mmddiagram metadata and guidance so subsequent decomposition, styling and CI linting operate from a single canonical template.architecture/diagrams to drive the View-based decomposition and automated SIZE checks.theme/mermaid-config.json+theme/custom.css) and avoid embedding%%{init:}blocks in new files.Description
docs/02-architecture/mmd-diagrams/_template.mmdcontaining the canonical metadata block (@version,@date,@type,@level,@status,@view,@parent,@nodes,@adr) and subgraph/style guidance while explicitly advising against%%{init:}blocks.docs/02-architecture/mmd-diagrams/architecture/*.mmd(18 files) to insert%% @status activeand%% @nodes ~<count>immediately after the existing%% @levelheader, preserving existing@version,@date,@type, and@levelvalues.foundation/orclass-diagrams/content, and left any legacy%%{init:}blocks intact as per policy; no rendering pipeline changes were made in this PR.Testing
architecture/files usingfor f in docs/02-architecture/mmd-diagrams/architecture/*.mmd; do count=$(grep -cP '^\s+\w+[\[\(\{>]' "$f" 2>/dev/null || echo 0); echo "$f: ~$count nodes"; done, which produced the approximate counts used for%% @nodes.%% @statusand%% @nodes, and the assertions passed for all 18 files.pip-auditexecutable and existing root-level VCR cassette guard failures for files:test_chembl_activity_full_run,test_pipeline_idempotency,test_pipeline_resume_after_failure,test_pubchem_compound_pipeline); these failures are unrelated to the documentation-only changes.Codex Task