Repository navigation
Docs: put Install first on the README - #793
Merged
Merged
Conversation
Make Install the first jump for newcomers: link it at the top of the hero nav and move the Install section to sit right after the hero so Cargo / Homebrew / Action / binaries are visible before the demo.
corvid-agent
requested review from
0xGaspar,
0xLeif,
Kyntrin and
tofu-ux
and removed request for
a team
September 22, 2026 13:49
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
3 participants
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.
Why
Newcomers need Install as the easiest first jump. The hero nav and section order should put getting SpecSync onto a machine ahead of the demo and workflow deep-dive.
What
README.md only:
[Install](#install)before Quick start / workflow / docs / examples / comparisons.## Installsection (Cargo / Homebrew / GitHub Action / Pre-built binaries) to sit immediately after the hero</div>/---and before## A contract change in 60 seconds.CorvidLabs/tap/spec-sync).No SpecSync lifecycle package: README.md is not in any active
files:list, and this matches recent root-docs practice (e.g. #786) for docs-only edits with no invented AC/HI criteria.Note
Main CI red from coverage timing flake is unrelated; this PR does not touch CI or coverage.
Test plan