Macros: explain sidebars & cross reference links. remove quicklinks lingo #31689
Conversation
This file contains 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
Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com>
teoli2003
suggested changes
Jan 16, 2024
|
|
||
| {{ListSubpagesForSidebar("/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros", 1)}} | ||
|
|
||
| ## Cross-reference links |
There was a problem hiding this comment.
Should we switch both H2 section, putting Cross-reference links first.
XRef macros are much more used and I think their docs are more likely to be what users are looking for.
There was a problem hiding this comment.
I put it in this order because this section is shorter, a quick read, and way easier to get through. Would not be upset if someone inverted them, but i find it easier to read this way, so prefer keeping it like this.
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
files/en-us/mdn/writing_guidelines/page_structures/links/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
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.
Follow up to #31248
Note re: create a sidebar section::
I removed the "how to create a sidebar" as people should not be creating one-off sidebars. I changed the lingo to "temporarily include a new sidebar". I think it's helpful to have it documented so that main contributors have something to look at and play with as they develop new sections of content. i am clear that it won't be approved. But I will be playing with "quick_links" as i create the A11y section sidebar, and will keep it around until such sidebar is merged into yari.