docs: restructure the README into a landing page with topic guides - #14
Merged
Merged
Conversation
…der docs/ The README now covers why, getting started in three steps, a real check sample, a command table, one CI caller and a minimal configuration. Reference material moves to docs/configuration.md, docs/checks.md (replacing quality-gate.md), docs/ci.md, docs/security.md and docs/development.md. The npm README mirrors the getting-started path. Every statement was checked against the code; several inherited inaccuracies (sample output rule names and adapter ids, CI refusal scope, container user, FORCE_COLOR=0, discovery attribution, hand-publish steps) are corrected on the way.
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
Researched how ruff, qlty, knip, dependency-cruiser, jscpd, pre-commit and reviewdog structure their READMEs: short landing page, one quick-start path, command table, one CI block, one real output sample, reference in docs. Applied that shape.
README.md: 131 lines (was 2760 words). Why → Getting started (3 steps) → What you get (realchecksample) → Commands table → CI caller → minimal configuration → Documentation index → Versioning.docs/configuration.md,docs/checks.md(replacesquality-gate.md),docs/ci.md,docs/security.md,docs/development.md: all previous content redistributed; no unique fact dropped (verified section by section), duplicates collapsed.launcher/README.md(npm page): mirrors the getting-started path and command table; lands on npmjs.com with the next release.CI=true|1|yestoo, container user semantics,FORCE_COLOR=0, discovery happens in every command not justinit, hand-publish steps, fixture count, Knip prerequisite fields, built-in exclusions list, Drupal excluded paths.Docs only. No code, no release.
Test plan
checkPASS (no code touched; sanity)