docs: add collapsible "How it works" section to README#42
Merged
Conversation
Adds a <details> block at the end of Getting started covering the file format, folder layout, and lifecycle. Renders as expand-on-click on GitHub; degrades to a long visible section if the marketplace renderer strips the wrapper. Single source of truth — no separate doc file. Covers: the two-file mental model (model YAML + domain JSON), the on-disk folder layout, anatomy of a model file and a domain file with field-reference tables, the Logical/Physical stage distinction with cardinality inference rules, AI harness install targets and the edit guard, auto-generated outputs (selectors.yml, discrepancy reports), and when to edit by hand vs the AI vs the canvas. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
<details>block at the end of Getting started covering the file format, folder layout, and full lifecycle for installed users.<details>wrapper, the inner content still reads as a coherent section thanks to clear###headings.selectors.ymland discrepancy outputs, and when to edit by hand vs AI vs canvas.Test plan
<details>block expands cleanly.<details>renders interactively, expanded, or stripped — adjust formatting if the inner content reads poorly when always-visible.🤖 Generated with Claude Code