Skip to content

Document the self-documenting Foundry pattern - #49

Merged
jmchilton merged 1 commit into
mainfrom
agent/documenting-a-foundry
Aug 6, 2026
Merged

Document the self-documenting Foundry pattern#49
jmchilton merged 1 commit into
mainfrom
agent/documenting-a-foundry

Conversation

@jmchilton

Copy link
Copy Markdown
Member

What changed

  • expand the existing Design Records page into the single home for the self-documenting Foundry pattern
  • add a responsive content/meta/ diagram, the typed directory contract, honest-gap guidance, and a concise adoption path
  • document the existing review-design-docs plugin skill and its change-routing behavior
  • update the Pattern landing page and related guidance to point to the consolidated authority
  • remove stale deterministic/model-boundary language so casting remains deterministic

Why

The proposed self-documentation overview and the existing Design Records reference were explaining the same pattern. Keeping both would create competing authorities and violate the ownership discipline the pages advocate. This folds the useful new material into the established content/pattern/design-records.md path that the review skill already treats as canonical.

Impact

Readers get one page that explains both why a Foundry documents itself and how each record is owned and maintained. Existing links and the review skill keep their canonical path.

Checks

  • npm test — 22 tests passed
  • npm run typecheck — no errors; one pre-existing unused-variable hint
  • npm run build — 28 pages built, 21 wiki-link targets checked
  • git diff --check

@jmchilton
jmchilton marked this pull request as ready for review August 6, 2026 14:35
@jmchilton
jmchilton merged commit 25bbb0b into main Aug 6, 2026
1 check passed
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