Fix broken themes link and make reference parameters searchable#9
Merged
Fix broken themes link and make reference parameters searchable#9
Conversation
…3 headings Co-authored-by: OrangeX4 <34951714+OrangeX4@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix broken links for themes documentation
Fix broken themes link and make reference parameters searchable
Mar 9, 2026
OrangeX4
approved these changes
Mar 9, 2026
|
There was a problem hiding this comment.
Pull request overview
Fixes two documentation UX issues in the Docusaurus site: a broken “build your own” link on the Themes page and poor search/navigation for hyphenated reference parameter names by making each parameter a searchable heading.
Changes:
- Update the Themes page link to point at the correct tutorial route.
- Generate parameter sections as
###headings (instead of####) so they become individually indexable/searchable entries and appear in the page TOC.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/pages/themes.js | Fixes the Themes page “build your own” docs link to the correct tutorial path. |
| scripts/generate-docs.py | Promotes generated parameter headings to H3 so search/TOC can target each parameter anchor directly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Two issues: the Themes page linked to a non-existent
/docs/build-your-own-theme, and searching for hyphenated parameter names likehorizontal-line-to-pagebreakreturned completely unrelated results instead of navigating to the correct anchor.Broken link (
src/pages/themes.js)/docs/build-your-own-theme→/docs/tutorials/build-your-own-theme, matching the actual path from the touying submodule (docs/en/tutorials/build-your-own-theme.md).Parameters not searchable (
scripts/generate-docs.py)docusaurus-lunr-searchonly creates individually-addressable search entries forh2/h3headings. Parameters were generated ash4, so they were indexed as undifferentiated body text — Lunr would tokenizehorizontal-line-to-pagebreakinto["horizontal", "line", "to", "pagebreak"]and return noise matches.Changed parameter headings from
####to###:Each parameter is now a separate indexed section pointing to e.g.
/docs/reference/configs/config-common#horizontal-line-to-pagebreak. Parameters also appear in the right-side TOC, enabling direct in-page navigation.🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.