Skip to content

Make the Foundry principles self-documenting - #37

Merged
jmchilton merged 5 commits into
mainfrom
doc-polish
Aug 4, 2026
Merged

Make the Foundry principles self-documenting#37
jmchilton merged 5 commits into
mainfrom
doc-polish

Conversation

@jmchilton

Copy link
Copy Markdown
Member

What changed

  • reorganize Guiding Principles into three scannable families with a consistent claim / why / requirement structure
  • add The Knowledge Base Documents Itself as a ninth principle, grounded in the instances' glossaries, typed meta/ records, kind documentation, and generated catalogs
  • add a responsive Ground → Explain → Cast → Check loop
  • add the new principle's concrete evidence to Principles in Action

Why

The previous page mixed invariant principles with long instance examples, making the commitments difficult to scan and obscuring the relationship among them. The rewrite separates those roles: Guiding Principles now states the domain-free commitments and their consequences, while Principles in Action holds the implementation evidence.

The new self-documentation principle names an architectural commitment both Foundries already share. A Foundry must explain its own vocabulary, structure, and transformation machinery rather than leaving that understanding in maintainer memory. The glossary, design records, kind documentation, and generated catalogs are complementary parts of that map.

Impact

The page is roughly 18% shorter despite growing from eight to nine principles. Readers get three balanced families, a repeatable structure for every principle, and a visual model of how evidence flows back into the source.

Validation

  • npm run build
  • npm run typecheck (passes with one unrelated existing hint)
  • npm test (22 tests)
  • git diff --check
  • generated HTML and responsive CSS inspected for the Guiding Principles loop

The in-app browser was unavailable for screenshot verification in this session.

@jmchilton
jmchilton marked this pull request as ready for review August 4, 2026 12:31
@jmchilton
jmchilton merged commit 60243ea into main Aug 4, 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