Commit 5b394f4
authored
docs: add README badges and reusable-workflow call-graph diagram (#29)
## 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 GitHub1 parent 7ef45c4 commit 5b394f4
4 files changed
Lines changed: 72 additions & 0 deletions
File tree
- docs
- diagrams
- explanation
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
| 116 | + | |
116 | 117 | | |
117 | 118 | | |
118 | 119 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
3 | 6 | | |
4 | 7 | | |
5 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
59 | 99 | | |
60 | 100 | | |
61 | 101 | | |
0 commit comments