docs: restructure README for navigability - #28
Merged
Merged
Conversation
…irst Reorganizes without changing any existing content: adds a badge row (npm version, license, CI status, release, provider support), a table of contents, promotes Quickstart/Install ahead of the demo table so a first-time visitor doesn't have to scroll past marketing content to find how to actually use it, adds a short problem-statement paragraph, expands CLI usage examples (--format json/markdown, --coverage), and adds a Documentation section linking METHODOLOGY.md/CHANGELOG.md/ CONTRIBUTING.md/SECURITY.md/CODE_OF_CONDUCT.md, none of which were previously linked from the README at all. Every existing heading is byte-identical to before (verified via a full sorted-line diff) so all internal anchors and any external deep links still resolve. No code changes -- no npm republish needed.
omrdev1
force-pushed
the
docs/readme-navigability
branch
from
September 12, 2026 08:21
f77ac15 to
80d1928
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.
Summary
--format json,--format markdown,--coverage)No content changes to any existing section; every heading is byte-identical to before so internal anchors and any external deep links still resolve. Docs only, no code changes, no npm republish needed.
Test plan
--format json/markdown,--coverage) verified againstcli.tsaction.ymlgreenops-cli@0.14.0)