Make the Foundry principles self-documenting - #37
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
meta/records, kind documentation, and generated catalogsWhy
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 buildnpm run typecheck(passes with one unrelated existing hint)npm test(22 tests)git diff --checkThe in-app browser was unavailable for screenshot verification in this session.