docs: add explicit single-page guide structure callout#25503
Open
brandonh6k wants to merge 2 commits into
Open
docs: add explicit single-page guide structure callout#25503brandonh6k wants to merge 2 commits into
brandonh6k wants to merge 2 commits into
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
1 task
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.
Description
Follow-up to #25338 (the guides revamp). That PR moved guides to a single-page structure, but STYLE.md never documented the convention, so it's easy for new guides to drift back into multi-page/directory-wrapped structures.
Adds:
.mdfiles directly undercontent/guides/(not<name>/index.md).content/guides/images/folder with slug-prefixed filenames as the convention (already the dominant pattern used by most guides).Companion PR that applies this convention to the remaining guides still using the old directory-wrapped structure: #25504
Related issues or tickets
Discussed in the team's docs Slack channel following #25338.
Reviews