Skip to content

docs: add README badges and reusable-workflow call-graph diagram#29

Merged
NWarila merged 1 commit into
mainfrom
chore/portfolio-alignment-v1
Jun 2, 2026
Merged

docs: add README badges and reusable-workflow call-graph diagram#29
NWarila merged 1 commit into
mainfrom
chore/portfolio-alignment-v1

Conversation

@NWarila

@NWarila NWarila commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a two-badge row to README.md (Repo CI workflow status, License MIT), matching the packer-framework-template badge style ([![CI](…)](…) then [![License: MIT](…)](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-hygienebaseline-manifest.json and reusable-org-adr-auto-syncorg-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", Co-authored-by — 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

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 NWarila merged commit 2651ece into main Jun 2, 2026
21 checks passed
@NWarila NWarila deleted the chore/portfolio-alignment-v1 branch June 2, 2026 19:51
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
(`[![CI](…)](…)` then `[![License: MIT](…)](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
(`[![CI](…)](…)` then `[![License: MIT](…)](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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant