docs: split the README into a slim README + topic docs#41
Merged
Conversation
Keep the README focused (pitch, install, quick start, init, run, example, why-SwiftSyntax, real-world, built-for-AI, performance, roadmap) and move the deep-dive material into docs/: configuration.md (config + AI prompt + dependencyOrder + visibility + security), adoption.md (baseline/suppressions/severity), integrations.md (Xcode/CI/SwiftPM/Danger/Claude/graph), tca.md. Add a Documentation section linking them; relative links adjusted (../examples, ../.claude, ../demo, security-rules.md, ../README.md anchors).
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.
The README had grown to 848 lines — pitch, install, full config reference, every integration, TCA, performance — so the pitch and quick start were buried.
What changed
Slim the README to ~290 lines (pitch, why, install, quick start,
init, run, example, why-SwiftSyntax, real-world, built-for-AI, performance, roadmap) and move the deep-dive material intodocs/, linked from a new Documentation section:docs/configuration.mddependencyOrder+ visibility + security checksdocs/adoption.md// solid:ignore, severitydocs/integrations.mddocs/tca.mddocs/security-rules.mdis unchanged.Integrity
](#…)local anchors in the README.../examples/,../.claude/,../demo/,security-rules.md#…,../README.md#generate-a-config-init.