Skip to content

Fix sidebar TOC display for section headings with JSX components in ALKiln setup page - #537

Merged
nonprofittechy merged 2 commits into
mainfrom
copilot/fix-sidebar-links-for-section-titles
Sep 11, 2025
Merged

Fix sidebar TOC display for section headings with JSX components in ALKiln setup page#537
nonprofittechy merged 2 commits into
mainfrom
copilot/fix-sidebar-links-for-section-titles

Conversation

Copilot AI commented Sep 9, 2025

Copy link
Copy Markdown
Contributor

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:

  • "GitHub+You™ test details" appeared as just "test details"
  • "ALKilnInThePlayground™ tests" appeared as just "tests"
  • "GitHub Sandbox™ tests (advanced)" appeared as just "tests (advanced)"

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.

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
Copilot AI requested a review from nonprofittechy September 9, 2025 13:46
@nonprofittechy

Copy link
Copy Markdown
Member

@plocket can you see if this fix is OK?

@BryceStevenWilley

Copy link
Copy Markdown
Contributor

Ran this locally, for what it's worth, it's working. Copies the text to the header, but that's probably fine.

Screenshot 2025-09-10 at 3 22 08 PM

@plocket

plocket commented Sep 10, 2025

Copy link
Copy Markdown
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 won't fix now. I think it's probably time to give up on this particular dream lol. I'm good with this PR.

@nonprofittechy
nonprofittechy marked this pull request as ready for review September 11, 2025 00:17
@nonprofittechy
nonprofittechy merged commit df8d68f into main Sep 11, 2025
3 checks passed
@nonprofittechy
nonprofittechy deleted the copilot/fix-sidebar-links-for-section-titles branch September 11, 2025 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ALKiln: Links in Section titles don't show up in the sidebar

4 participants