-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: move "Reserved binding keys" to "Reference guides" #5775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
4a62f7e to
58ada00
Compare
| toc_level: 1 | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/Reserved-binding-keys.html | ||
| permalink: /doc/en/lb4/reference-reserved-binding-keys.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's capitalize the first letter to be consistent with our urls.
/doc/en/lb4/Reference-reserved-binding-keys.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to transition our URL scheme to all-lowercase names and eventually to nested paths (/reference/reserved-binding-keys.html) to match the directory layout in docs/site.
I encountered some issues when using nested paths, so I am using - instead of / for now:
reference/reserved-binding-keys.md -> reference-reserved-binding-keys.html
We are already following the all-lowercase slug style in migration guide, see e.g. here:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's discuss in #5798
docs/site/sidebars/lb4_sidebar.yml
Outdated
| output: 'web, pdf' | ||
|
|
||
| - title: 'Reserved binding keys' | ||
| url: reference-reserved-binding-keys.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto.
dhmlau
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once @raymondfeng's comment is addressed. Thanks.
|
Based on discussion with @raymondfeng, we will stick with Sentence-style.html to land my PRs and then normalize URL slugs afterwards, as this part may take a bit longer to reach consensus. |
58ada00 to
ffccaf0
Compare
Also remove "Overview" heading from the page. I feel the heading is redundant when there are no other headings. Before this change, the page was rendered with a single-item Table of Contents at the top, which looked weird to me. After this change, the pages is rendered as a single block with the page title as the only heading. Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
ffccaf0 to
95606b2
Compare
Also remove "Overview" heading from the page. I feel the heading is redundant when there are no other headings. Before this change, the page was rendered with a single-item Table of Contents at the top, which looked weird to me. After this change, the pages is rendered as a single block with the page title as the only heading.
This is a follow-up to #5718, see also #5549.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈