docs(readme): add Quick Start jump block, label OS-specific install sections#36
Merged
Conversation
…ections Adds a GitHub-flavored note block at the top of Quick Start with anchored links to the major install paths (Linux manual/Docker/scripts, Windows, post-install) so newcomers can navigate without scrolling. Renames "Prerequisites"/"Installation" to "Linux Prerequisites"/"Linux Installation" so they parallel "Windows Installation" and so the jump anchors are unambiguous. Heading hierarchy under ## Quick Start is preserved at H3, so distros and Docker sub-options remain at H4 as before. Supersedes #29 by keeping the navigation improvement without demoting headings or removing the "Creating Your First Site" walkthrough.
This was referenced May 19, 2026
Closed
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
> [!NOTE]"Jump to" block at the top of Quick Start with anchored links to the major install paths (Linux manual / Docker / automated script, Windows) and post-install sections (first site, configuration, usage).### Prerequisites→### Linux Prerequisitesand### Installation→### Linux Installationso they parallel### Windows Installationand the jump anchors are unambiguous.Why
#29 proposed the same navigation improvement, which is a good idea. This PR keeps that improvement while addressing the structural issues raised in review there:
## Quick Startstay at H3 (no skip from H2 → H4). Distros and Docker sub-options remain at H4 as before.#linux-installation,#docker-installation,#convenience-scripts,#windows-installation,#creating-your-first-site,#configuration,#usage.Test plan
grep -n "^#" README.mdshows continuous H2 → H3 → H4 hierarchy in Quick Start.[!NOTE]callout correctly.Credit to @slrslr (#29) for the navigation idea.