Skip to content

docs: Part 11 (Retros, Recursively) + README freshness guard#6

Merged
Akibalogh merged 1 commit into
mainfrom
docs/11-retros-recursively-and-readme-guard
Jun 22, 2026
Merged

docs: Part 11 (Retros, Recursively) + README freshness guard#6
Akibalogh merged 1 commit into
mainfrom
docs/11-retros-recursively-and-readme-guard

Conversation

@Akibalogh

Copy link
Copy Markdown
Owner

What

  1. Add Part 11 — Retros, Recursively (docs/articles/11-retros-recursively.md). Renumbered from the stale feat/article-08-retros-recursively branch (8/9/10 were already taken/merged). Substantive original content on the recursive-retro process — distinct from Part 7 (monitors/alerts) and Part 8 (capability coverage/guards). Front-matter part/slug and intro references fixed to 11; cross-links to Parts 2/6/7 preserved.
  2. Index articles 9, 10, 11 in the top-level README.md (it had silently stopped at 8) and add Part 11 to docs/articles/README.md.
  3. README freshness guard (Aki: "make sure the README is updated when we push new content"): scripts/check-readme-articles.sh fails if any docs/articles/NN-*.md isn't indexed in BOTH READMEs. Wired as CI (.github/workflows/check-readme-articles.yml, runs on PRs incl. forks) + an installable local pre-commit hook (scripts/install-git-hooks.sh). Fixture test (scripts/test-check-readme-articles.sh) proves it catches an unlisted article. Documented in CONTRIBUTING.md.

Verify

  • bash scripts/check-readme-articles.sh → OK
  • bash scripts/test-check-readme-articles.sh → 2/2 pass

The stale feat/article-08-retros-recursively branch can be deleted after this merges — its content lives here as Part 11.

🤖 Generated with Claude Code

- Add docs/articles/11-retros-recursively.md (renumbered from the stale
  feat/article-08-retros-recursively branch; 8/9/10 were taken). Substantive
  original content on the recursive-retro process — distinct from Part 7
  (monitors/alerts) and Part 8 (capability coverage/guards). Front-matter
  part/slug fixed to 11; intro Part references updated.
- Index articles 9, 10, 11 in top-level README.md (it had stopped at 8);
  add Part 11 row to docs/articles/README.md.
- README freshness guard so a new docs/articles/NN-*.md can't ship without
  being indexed: scripts/check-readme-articles.sh (single source of truth),
  CI workflow .github/workflows/check-readme-articles.yml, installable
  pre-commit hook (scripts/git-hooks + install-git-hooks.sh), fixture test
  (scripts/test-check-readme-articles.sh), documented in CONTRIBUTING.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Akibalogh Akibalogh merged commit ec03b10 into main Jun 22, 2026
1 check passed
@Akibalogh Akibalogh deleted the docs/11-retros-recursively-and-readme-guard branch June 22, 2026 22:51
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.

2 participants