docs: overhaul documentation for clarity, consistency, and a leaner README - #91
Merged
Conversation
…EADME Full pass across the documentation surface following the v0.19 release: - Rewrite README as a lean landing page whose sections link into docs/; add two infographics (the three-file model and the stability growth chart). - Trim verbosity across backends, reference, comparisons, and examples. - Remove em dashes repo-wide; strip internal KB/wiki references and ticket IDs from the docs and the CHANGELOG (full-detail snapshot retained in the KB). - Condense and clean the CHANGELOG: link every tagged release and consolidate duplicate per-release subsections. - Backend pages: metadata as bullet lists, split the CLI version into its own field, drop platform-specific install commands, bump the Tested stamp to v0.19.0. - Comparison tables now lead with SecretEnv, then the compared tool. - Consolidate redaction docs into reference/redact.md; fix the security.md "Reading the Table" prose to match the table. - Move ci-cd.md into guides/; add a stability page and an org-rollout guide; fix See-also/Related links across the reference docs. Co-Authored-By: Claude Opus 4.8 (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
A full documentation pass following the v0.19 release. No code changes and no release tag (docs only). Net ~1k lines lighter.
Highlights
docs/, with two new infographics (the three-file model and the live-smoke growth chart).reference/redact.md;security.md"Reading the Table" prose fixed to match the table.ci-cd.mdmoved intoguides/; new stability page + org-rollout guide; See-also/Related links fixed across reference docs.Verification
ignoreDeadLinks).🤖 Generated with Claude Code