Point the README to the documentation site for details - #17
Merged
Merged
Conversation
The README keeps the pitch, example, rule groups, install, quick start, the CI example, exit codes and privacy in 111 lines, and links each topic's page on the site, which holds the full text.
tauanbinato
force-pushed
the
slim-readme
branch
from
September 26, 2026 02:22
2f71608 to
8ed6236
Compare
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.
What and why
Phase 4 of the roadmap: the README goes from 319 lines to 111 and links the documentation site for details.
Kept: the pitch, the example output, a table of rule groups with how to turn each on, a two-sentence summary of languages and frameworks, install, quick start, the GitHub Action example, output formats and exit codes, privacy and cost, contributing and license.
Moved to the site (already there, word for word, from #15): the per-rule example tables, the language and framework matrices, the CI details (forks, budgets, retries, base-branch policy, pre-commit), the configuration table and scopes, the baseline and its reasons, how it works, and limits.
A line of links under the example goes to the site's documentation, rules, configuration, CI and troubleshooting pages, and the changelog.
How it was checked
Every site link in the new README points to a page the site serves; the facts kept were checked against the site's pages.