Fix sidebar TOC display for section headings with JSX components in ALKiln setup page - #537
Merged
nonprofittechy merged 2 commits intoSep 11, 2025
Merged
Conversation
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ALKiln: Links in Section titles don't show up in the sidebar
Fix sidebar TOC display for section headings with JSX components in ALKiln setup page
Sep 9, 2025
Member
|
@plocket can you see if this fix is OK? |
Contributor
Collaborator
|
I was aware of this problem and I was hoping it would get fixed in docusaurus relatively quickly. It looks like it's a |
nonprofittechy
marked this pull request as ready for review
September 11, 2025 00:17
nonprofittechy
deleted the
copilot/fix-sidebar-links-for-section-titles
branch
September 11, 2025 00:17
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.

The sidebar table of contents (TOC) was not properly displaying section headings that contained JSX components in the ALKiln setup documentation. This caused confusing entries where detailed section titles appeared as generic text like "test details" instead of the full descriptive names.
Problem:
Section headings using JSX components like
<GTOYS/>,<AutoDIY/>, and<KittyLitter/>were not being rendered properly for TOC generation. For example:This made navigation confusing as multiple sections had the same generic labels in the sidebar.
Solution:
Replaced JSX components in section headings with their plain text equivalents:
<GTOYS/>→ "GitHub+You™"<AutoDIY/>→ "ALKilnInThePlayground™"<KittyLitter/>→ "GitHub Sandbox™"Result:
The sidebar TOC now correctly displays full, descriptive section titles that help users navigate between different test setup methods and their details. All internal links continue to work properly.
Fixes #443.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.