fix: JSDoc code block syntax in TableOfContents component

[ainsleyclark]

Summary

Updated JSDoc example code blocks in the TableOfContents component to use correct JavaScript/JSX comment syntax instead of HTML comment syntax.

Changes

• Converted HTML comments (<!-- -->) to JavaScript block comments ({/* */}) in all four JSDoc @example blocks
• This ensures the code examples are syntactically correct for Svelte/JavaScript contexts

Details

The documentation examples were using HTML comment syntax within Svelte code blocks, which is incorrect. JavaScript block comments are the appropriate syntax for these examples and will render correctly in documentation generators and IDEs that parse JSDoc comments.

https://claude.ai/code/session_0172a2vJSGboESNTT38sDb9U

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[claude]

Review summary

• Overall score: 8/10
• Critical issues: 0
• Warnings: 1
• Suggestions: 1
• Recommendation: Approve with comments

Correct, targeted fix for a genuine runtime bug. The nested HTML comments inside the outer @component HTML comment block were causing Svelte to prematurely close the comment and attempt to parse <RichText> and <TableOfContents> as real template markup. Changeset is appropriately scoped and descriptive.

Critical issues

None

Warnings

Loss of example context — The removed comments (Attach data attributes, TOC auto-discovers headings, Explicit prop overrides, Manual items) provided meaningful explanation for each @example block. Without them, the reader must infer the intent from the code alone. The first example's distinction between the two elements and the fourth example's nuance about scrollspy still being DOM-driven are non-obvious.

Suggestions

Consider {/* */} instead of removing comments — The original approach in the first commit (replacing <!-- --> with {/* */}) would preserve the explanatory text while fixing the parsing issue. Svelte block comments are idiomatic inside @example svelte code blocks and are valid in documentation generators (sveld, etc.):

{/* Attach data attributes to the content element */}
<RichText content={data.body} data-sidebar-content="true" data-sidebar-selector="h3" />
{/* TOC auto-discovers headings */}
<TableOfContents heading="On this page" />

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.26%. Comparing base (7f6b060) to head (86225e0).
⚠️ Report is 516 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #431      +/-   ##
==========================================
+ Coverage   64.59%   70.26%   +5.67%     
==========================================
  Files         154      187      +33     
  Lines        6064     7439    +1375     
==========================================
+ Hits         3917     5227    +1310     
+ Misses       2064     2012      -52     
- Partials       83      200     +117     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.