Cut README to prospect length; align copy to ecosystem canon#4
Merged
Conversation
Part of the cross-repo positioning convergence (canon lives in the private af-site repo): - Tagline is now "A reconciliation engine for design systems" with the canonical one-liner as the intro; "control plane" tagline, "This is a new category", "Git for UI state", and "validate a new category" are removed. - Patent reference replaced with the single approved sentence. - README cut roughly in half: CLI reference, project structure, and environment variables now live behind links to docs/ (cli-reference already covered commands; architecture-reference gains the refreshed repository layout, which had drifted from reality - missing cli package, vue demo, designAdapter, crossSurfaceDrift). - Open-core essay relocated to new docs/open-core.md; README keeps the two canonical sentences and a link. - Key Properties precedence row now says "code defaults" so prose and the override > marker > ast > code chain agree; reconciliation-model doc gains a sentence naming all four levels. - Fixed CLAUDE.md link casing (claude.md 404s on GitHub). - Em-dashes removed from rewritten copy. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to align product positioning and keep canonical docs consistent: the README is shortened to a prospect-focused overview, while detailed reference material is moved/linked into docs/.
Changes:
- Condense and restructure
README.md(prospect-focused copy; link out to CLI + architecture docs; updated open-core + patent sentence). - Add
docs/open-core.mdand adjust documentation index to reference it. - Refresh internal reference docs (
docs/architecture-reference.mdrepo tree;docs/reconciliation-model.mdprecedence clarification).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Shortened prospect-focused overview; links out to detailed docs; updates Open Core + license/patent copy |
| docs/reconciliation-model.md | Adds a clarifying sentence describing the four precedence levels |
| docs/open-core.md | New doc containing the open-core direction essay moved out of the README |
| docs/architecture-reference.md | Updates repository layout section to reflect current monorepo structure |
Comment on lines
+179
to
+180
| | [docs/open-core.md](docs/open-core.md) | Everyone | Open core model, what is open, what may evolve | | ||
| | [CLAUDE.md](CLAUDE.md) | Claude AI | Project context for AI-assisted development | |
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
The repo-convergence slice of the ecosystem positioning work (the canon and full plan live in the private af-site repo, see af-site#3).
README (359 → ~190 lines, prospect-focused)
override > marker > ast > codechain.claude.md→CLAUDE.mdlink casing (404 on GitHub's case-sensitive raw view).Docs
docs/open-core.mdcarries the relocated Open Source + Commercial Direction essay (content preserved; "new category" line removed, canon open-core sentence added).docs/architecture-reference.md: Repository layout refreshed from the README's newer tree — the doc's copy had drifted (missingpackages/cli,vue-demo-app,designAdapter/,crossSurfaceDrift/).docs/reconciliation-model.md: one added sentence naming all four precedence levels, keeping thecodeidentifier (it maps to source) while clarifying it means default code behavior.Reviewer notes
feat/dspack-contract-surfacecarries commit 09d7187 ("address PR review") that was never pushed before Add dspack contract surface to cross-surface drift analysis #3 merged — watcher code + tests, unrelated to this PR, may need its own follow-up.🤖 Generated with Claude Code