Repository navigation
Style guide: show step numbers once (sidebar label, not H1) - #166
Open
loganlipscomb wants to merge 2 commits into
Open
loganlipscomb wants to merge 2 commits into
loganlipscomb wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
|
NetFoundry Preview
None of the 1 changed files matched a documentation path. |
This branch has not been deployed
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
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.
Adds a "Numbered steps" subsection under Headings:
sidebar_label, not the H1. H1s are standalone imperative titles, which readbetter in search results and browser tabs.
N.instead ofStep N:(for example,## 1. Install the agent).Also replaces the colon-capitalization example ("Step 1: Install the agent"), since it modeled the pattern this
change removes.
This follows Google's developer style guide (don't number headings to indicate sequence) and similar guidance from
Adobe and Zapier, while keeping numbered sidebar labels for navigation.