docs: add What's next? carve-out to the Learn more style rule#27163
Draft
nickvigilante wants to merge 1 commit into
Draft
docs: add What's next? carve-out to the Learn more style rule#27163nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
Keep the ## Learn more, not Next steps heading and ban, and add a ### Sequenced tutorials: What's next? subsection so ordered tutorials can point to the single next tutorial in the series. Update the enforcement note to clarify the planned rule flags Next steps, not What's next?.
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.
What
Adds a What's next? carve-out to the Learn more, not Next steps rule in the docs style guide (
docs/.style/style-guide/word-choice.md).The existing
## Learn more, not Next stepsheading, its two rationales, and the ban on Next steps are unchanged, so the#learn-more-not-next-stepsanchor is preserved. A new### Sequenced tutorials: What's next?subsection lets a tutorial in an ordered series point to the single next tutorial, and the enforcement note now clarifies that the plannedCoder.LearnMorerule flags Next steps, not What's next?.Why
What's next? and Learn more do different jobs:
The What's next? phrasing also avoids the "steps" mobility metaphor, so the inclusive-language reason for banning Next steps still holds.
The merged Quickstart "Customize your template" series (#26712) already uses What's next? sections, so this codifies the pattern those pages adopted.
Implementation plan and decision log
## Learn more, not Next steps(preserves the anchor and the core ban).### Sequenced tutorials: What's next?after the Learn more Do/Don't examples: a tutorial in an ordered series may add a What's next? section pointing to the single next tutorial, placed above Learn more, written as a short sentence with the link.Coder.LearnMore(planned). The planned rule flags Next steps, not What's next?.Decisions:
#learn-more-not-next-stepsanchor intact.Generated by Coder Agents on behalf of @nickvigilante.