docs: add README badges and reusable-workflow call-graph diagram#29
Merged
Conversation
Add CI and License badges to README matching sibling repo badge style (packer-framework-template pattern: CI badge + License badge). Add docs/diagrams/reusable-workflow-call-graph.mmd — the first diagram in this repo — showing a consumer repo calling the seven universal reusable workflows by SHA, and the drift-gate relationship between reusable-repo-hygiene/baseline-manifest.json and reusable-org-adr-auto-sync/org-adr-manifest.json. Embed the diagram inline in docs/explanation/repo-type-taxonomy-and-ci-focus.md with a source link per the diagram-conventions reference doc. Allowlist docs/diagrams/reusable-workflow-call-graph.mmd in .gitignore (deny-all strategy requires explicit per-file entries).
NWarila
added a commit
that referenced
this pull request
Jun 5, 2026
## Summary - Adds a two-badge row to `README.md` (Repo CI workflow status, License MIT), matching the `packer-framework-template` badge style (`[](…)` then `[](LICENSE)`). - Adds the first Mermaid diagram to this repo: `docs/diagrams/reusable-workflow-call-graph.mmd` — a flowchart showing a consumer repo calling all seven universal reusables by SHA, with the drift-gate relationship between `reusable-repo-hygiene` ↔ `baseline-manifest.json` and `reusable-org-adr-auto-sync` ↔ `org-adr-manifest.json`. - Embeds the diagram inline in `docs/explanation/repo-type-taxonomy-and-ci-focus.md` with a source link per `docs/reference/diagram-conventions.md`. - Allowlists `docs/diagrams/reusable-workflow-call-graph.mmd` in `.gitignore` (deny-all strategy requires explicit per-file entries). ## Ruleset note (no change in this PR) The "Default Branch Protection" ruleset on this repo is currently active but empty — no rules are configured inside it. It is vestigial and should be removed via terraform in a follow-on infrastructure change. This PR does not touch rulesets. ## Validation - `python tools/check_docs_layout.py` — passes - `python tools/check_adr_schema.py` — passes - `python tools/check_baseline_manifest.py` — passes - `npx markdownlint-cli2 "**/*.md"` — 0 errors - `git status --short` after staging — all 4 changed files tracked (none ignored) - Diff scanned for AI bylines, "generated by", coauthor trailer — none present ## Test plan - [ ] Repo CI workflow passes (actionlint, markdownlint, docs-layout, adr-schema, baseline-manifest, attribution-residue, smoke tests) - [ ] README badges render correctly on the repo landing page - [ ] Mermaid diagram renders in `docs/explanation/repo-type-taxonomy-and-ci-focus.md` on GitHub
NWarila
added a commit
that referenced
this pull request
Jun 6, 2026
## Summary - Adds a two-badge row to `README.md` (Repo CI workflow status, License MIT), matching the `packer-framework-template` badge style (`[](…)` then `[](LICENSE)`). - Adds the first Mermaid diagram to this repo: `docs/diagrams/reusable-workflow-call-graph.mmd` — a flowchart showing a consumer repo calling all seven universal reusables by SHA, with the drift-gate relationship between `reusable-repo-hygiene` ↔ `baseline-manifest.json` and `reusable-org-adr-auto-sync` ↔ `org-adr-manifest.json`. - Embeds the diagram inline in `docs/explanation/repo-type-taxonomy-and-ci-focus.md` with a source link per `docs/reference/diagram-conventions.md`. - Allowlists `docs/diagrams/reusable-workflow-call-graph.mmd` in `.gitignore` (deny-all strategy requires explicit per-file entries). ## Ruleset note (no change in this PR) The "Default Branch Protection" ruleset on this repo is currently active but empty — no rules are configured inside it. It is vestigial and should be removed via terraform in a follow-on infrastructure change. This PR does not touch rulesets. ## Validation - `python tools/check_docs_layout.py` — passes - `python tools/check_adr_schema.py` — passes - `python tools/check_baseline_manifest.py` — passes - `npx markdownlint-cli2 "**/*.md"` — 0 errors - `git status --short` after staging — all 4 changed files tracked (none ignored) present ## Test plan - [ ] Repo CI workflow passes (actionlint, markdownlint, docs-layout, adr-schema, baseline-manifest, attribution-residue, smoke tests) - [ ] README badges render correctly on the repo landing page - [ ] Mermaid diagram renders in `docs/explanation/repo-type-taxonomy-and-ci-focus.md` on GitHub
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.
Summary
README.md(Repo CI workflow status, License MIT), matching thepacker-framework-templatebadge style ([](…)then[](LICENSE)).docs/diagrams/reusable-workflow-call-graph.mmd— a flowchart showing a consumer repo calling all seven universal reusables by SHA, with the drift-gate relationship betweenreusable-repo-hygiene↔baseline-manifest.jsonandreusable-org-adr-auto-sync↔org-adr-manifest.json.docs/explanation/repo-type-taxonomy-and-ci-focus.mdwith a source link perdocs/reference/diagram-conventions.md.docs/diagrams/reusable-workflow-call-graph.mmdin.gitignore(deny-all strategy requires explicit per-file entries).Ruleset note (no change in this PR)
The "Default Branch Protection" ruleset on this repo is currently active but empty — no rules are configured inside it. It is vestigial and should be removed via terraform in a follow-on infrastructure change. This PR does not touch rulesets.
Validation
python tools/check_docs_layout.py— passespython tools/check_adr_schema.py— passespython tools/check_baseline_manifest.py— passesnpx markdownlint-cli2 "**/*.md"— 0 errorsgit status --shortafter staging — all 4 changed files tracked (none ignored)Test plan
docs/explanation/repo-type-taxonomy-and-ci-focus.mdon GitHub