docs(diagrams): add mmd template, architecture metadata, linter support and ADR-040#2400
Closed
SatoryKono wants to merge 1 commit intomainfrom
Closed
docs(diagrams): add mmd template, architecture metadata, linter support and ADR-040#2400SatoryKono 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 format and metadata so decomposed views and CI checks can be automated.Description
docs/02-architecture/mmd-diagrams/_template.mmdwith standardized%% @*metadata and theming guidance.architecture/*.mmdfiles with%% @status activeand%% @nodes <count>(18 files updated) and createddocs/02-architecture/decisions/ADR-040-diagram-governance.mddocumenting the new governance.docs/02-architecture/mmd-diagrams/render.shto skip files marked%% @status supersededduring rendering.scripts/lint_diagrams.pyto support canonical.mmdplus legacy.mermaid, to skipsuperseded/legendfiles, and to add checks forVIEW-*,SIZE-*,COLOUR-*andHACK-*rules and node-count heuristics.lint-diagramsin.pre-commit-config.yamland updateddocs/02-architecture/mmd-diagrams/README.mdanddocs/02-architecture/06-diagram-policy.mdto reference ADR-040 and the new rules.Testing
python -m py_compile scripts/lint_diagrams.pywhich succeeded.python scripts/lint_diagrams.py docs/02-architecture/mmd-diagrams/architecture --stale-days 365, which reported expected policy issues includingSIZE-001(CRITICAL oversized diagrams) for files such as01-high-level-hexagonal.mmd,03-medallion-data-flow.mmd, and13-port-protocol-contracts.mmd, andCONTENT-001(placeholder) for05-provider-adapter-hierarchy.mmd.pip-auditin the environment, legacy config-path references, and root-level VCR cassettes) which are out-of-scope for this PR and do not block the functional changes to templates, linter, render script, and ADR.Codex Task