chore(ui): add toc #567
Open
chore(ui): add toc #567
+24
−14
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #567 +/- ##
==========================================
- Coverage 80.72% 80.68% -0.04%
==========================================
Files 128 128
Lines 12378 12389 +11
Branches 887 887
==========================================
+ Hits 9992 9996 +4
- Misses 2383 2390 +7
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
| File | Base | Head | Diff |
|---|---|---|---|
orama-db.json |
8.02 MB | 8.02 MB | +1.86 KB (+0.02%) |
web Generator
| File | Base | Head | Diff |
|---|---|---|---|
errors.js |
322.66 KB | 394.91 KB | +72.25 KB (+22.39%) |
errors.html |
402.64 KB | 448.79 KB | +46.15 KB (+11.46%) |
deprecations.js |
257.07 KB | 296.32 KB | +39.25 KB (+15.27%) |
cli.js |
284.57 KB | 317.09 KB | +32.53 KB (+11.43%) |
crypto.js |
1.21 MB | 1.24 MB | +26.58 KB (+2.15%) |
http.js |
711.55 KB | 736.86 KB | +25.31 KB (+3.56%) |
fs.js |
1.30 MB | 1.33 MB | +24.61 KB (+1.85%) |
deprecations.html |
472.07 KB | 495.71 KB | +23.64 KB (+5.01%) |
cli.html |
469.80 KB | 491.33 KB | +21.53 KB (+4.58%) |
quic.js |
193.12 KB | 213.24 KB | +20.12 KB (+10.42%) |
perf_hooks.js |
382.67 KB | 401.99 KB | +19.32 KB (+5.05%) |
buffer.js |
1.12 MB | 1.13 MB | +18.55 KB (+1.62%) |
n-api.js |
700.76 KB | 718.60 KB | +17.84 KB (+2.55%) |
process.js |
727.41 KB | 745.02 KB | +17.61 KB (+2.42%) |
util.js |
777.92 KB | 795.13 KB | +17.22 KB (+2.21%) |
test.js |
860.30 KB | 876.83 KB | +16.53 KB (+1.92%) |
http.html |
681.23 KB | 697.25 KB | +16.03 KB (+2.35%) |
crypto.html |
956.13 KB | 971.99 KB | +15.86 KB (+1.66%) |
fs.html |
1.25 MB | 1.26 MB | +14.80 KB (+1.16%) |
net.js |
298.62 KB | 312.13 KB | +13.51 KB (+4.52%) |
webcrypto.js |
447.18 KB | 460.15 KB | +12.97 KB (+2.90%) |
quic.html |
332.28 KB | 345.08 KB | +12.79 KB (+3.85%) |
globals.js |
123.48 KB | 135.40 KB | +11.92 KB (+9.65%) |
tls.js |
334.40 KB | 346.09 KB | +11.70 KB (+3.50%) |
perf_hooks.html |
348.75 KB | 360.39 KB | +11.64 KB (+3.34%) |
buffer.html |
832.96 KB | 844.32 KB | +11.36 KB (+1.36%) |
n-api.html |
807.57 KB | 818.66 KB | +11.09 KB (+1.37%) |
zlib.js |
321.41 KB | 331.93 KB | +10.52 KB (+3.27%) |
util.html |
638.30 KB | 648.64 KB | +10.34 KB (+1.62%) |
worker_threads.js |
409.43 KB | 419.35 KB | +9.92 KB (+2.42%) |
process.html |
632.66 KB | 642.43 KB | +9.78 KB (+1.55%) |
test.html |
665.02 KB | 674.79 KB | +9.76 KB (+1.47%) |
events.js |
566.67 KB | 575.78 KB | +9.10 KB (+1.61%) |
dns.js |
281.92 KB | 290.89 KB | +8.97 KB (+3.18%) |
vm.js |
370.67 KB | 379.42 KB | +8.75 KB (+2.36%) |
net.html |
330.35 KB | 338.83 KB | +8.48 KB (+2.57%) |
sqlite.js |
231.75 KB | 239.83 KB | +8.08 KB (+3.49%) |
webcrypto.html |
503.02 KB | 510.71 KB | +7.69 KB (+1.53%) |
v8.js |
345.94 KB | 353.56 KB | +7.62 KB (+2.20%) |
stream.js |
901.14 KB | 908.74 KB | +7.60 KB (+0.84%) |
tls.html |
339.67 KB | 346.77 KB | +7.10 KB (+2.09%) |
globals.html |
215.35 KB | 221.64 KB | +6.29 KB (+2.92%) |
child_process.js |
483.15 KB | 489.13 KB | +5.98 KB (+1.24%) |
worker_threads.html |
342.47 KB | 348.43 KB | +5.96 KB (+1.74%) |
zlib.html |
266.68 KB | 272.58 KB | +5.90 KB (+2.21%) |
dgram.js |
178.07 KB | 183.96 KB | +5.89 KB (+3.31%) |
http2.js |
849.46 KB | 855.06 KB | +5.60 KB (+0.66%) |
events.html |
426.05 KB | 431.27 KB | +5.23 KB (+1.23%) |
readline.js |
232.79 KB | 237.93 KB | +5.14 KB (+2.21%) |
assert.js |
463.15 KB | 468.26 KB | +5.12 KB (+1.10%) |
dns.html |
273.47 KB | 278.53 KB | +5.06 KB (+1.85%) |
vm.html |
321.91 KB | 326.91 KB | +5.00 KB (+1.55%) |
inspector.js |
126.64 KB | 131.58 KB | +4.94 KB (+3.90%) |
sqlite.html |
230.46 KB | 235.36 KB | +4.90 KB (+2.13%) |
esm.js |
133.81 KB | 138.70 KB | +4.89 KB (+3.65%) |
stream.html |
808.62 KB | 813.20 KB | +4.58 KB (+0.57%) |
modules.js |
152.88 KB | 157.39 KB | +4.51 KB (+2.95%) |
v8.html |
294.87 KB | 299.34 KB | +4.47 KB (+1.52%) |
cluster.js |
201.67 KB | 206.04 KB | +4.37 KB (+2.17%) |
module.js |
347.05 KB | 351.39 KB | +4.33 KB (+1.25%) |
async_context.js |
189.42 KB | 193.69 KB | +4.26 KB (+2.25%) |
timers.js |
102.89 KB | 106.96 KB | +4.07 KB (+3.95%) |
webstreams.js |
303.72 KB | 307.59 KB | +3.87 KB (+1.28%) |
console.js |
110.18 KB | 113.96 KB | +3.78 KB (+3.43%) |
child_process.html |
356.61 KB | 360.30 KB | +3.68 KB (+1.03%) |
packages.js |
122.38 KB | 126.02 KB | +3.64 KB (+2.98%) |
single-executable-applications.js |
79.44 KB | 83.03 KB | +3.59 KB (+4.52%) |
dgram.html |
177.63 KB | 181.19 KB | +3.56 KB (+2.01%) |
http2.html |
718.69 KB | 722.14 KB | +3.45 KB (+0.48%) |
repl.js |
211.97 KB | 215.42 KB | +3.44 KB (+1.62%) |
os.js |
111.67 KB | 115.03 KB | +3.35 KB (+3.00%) |
url.js |
343.89 KB | 347.23 KB | +3.33 KB (+0.97%) |
https.js |
162.67 KB | 165.99 KB | +3.33 KB (+2.04%) |
readline.html |
233.73 KB | 236.96 KB | +3.23 KB (+1.38%) |
inspector.html |
160.51 KB | 163.53 KB | +3.01 KB (+1.88%) |
esm.html |
149.72 KB | 152.69 KB | +2.97 KB (+1.98%) |
tty.js |
50.40 KB | 53.37 KB | +2.97 KB (+5.89%) |
modules.html |
173.04 KB | 175.75 KB | +2.71 KB (+1.56%) |
async_hooks.js |
188.92 KB | 191.58 KB | +2.66 KB (+1.41%) |
assert.html |
317.96 KB | 320.61 KB | +2.65 KB (+0.83%) |
module.html |
305.59 KB | 308.23 KB | +2.64 KB (+0.86%) |
cluster.html |
185.05 KB | 187.60 KB | +2.55 KB (+1.38%) |
timers.html |
119.74 KB | 122.28 KB | +2.54 KB (+2.12%) |
async_context.html |
154.13 KB | 156.66 KB | +2.54 KB (+1.65%) |
console.html |
135.85 KB | 138.26 KB | +2.41 KB (+1.78%) |
webstreams.html |
322.03 KB | 324.43 KB | +2.40 KB (+0.75%) |
packages.html |
151.57 KB | 153.90 KB | +2.33 KB (+1.54%) |
addons.js |
297.86 KB | 300.12 KB | +2.27 KB (+0.76%) |
path.js |
102.98 KB | 105.24 KB | +2.26 KB (+2.20%) |
single-executable-applications.html |
102.77 KB | 104.91 KB | +2.14 KB (+2.08%) |
repl.html |
174.82 KB | 176.94 KB | +2.13 KB (+1.22%) |
domain.js |
90.54 KB | 92.62 KB | +2.08 KB (+2.30%) |
url.html |
322.54 KB | 324.60 KB | +2.06 KB (+0.64%) |
https.html |
141.01 KB | 142.97 KB | +1.97 KB (+1.39%) |
os.html |
131.69 KB | 133.62 KB | +1.93 KB (+1.46%) |
styles.css |
120.39 KB | 122.28 KB | +1.89 KB (+1.57%) |
tty.html |
85.38 KB | 87.27 KB | +1.88 KB (+2.21%) |
typescript.js |
23.97 KB | 25.59 KB | +1.62 KB (+6.78%) |
async_hooks.html |
147.85 KB | 149.46 KB | +1.61 KB (+1.09%) |
intl.js |
35.36 KB | 36.87 KB | +1.51 KB (+4.28%) |
addons.html |
263.20 KB | 264.65 KB | +1.45 KB (+0.55%) |
wasi.js |
43.23 KB | 44.54 KB | +1.31 KB (+3.03%) |
punycode.js |
28.63 KB | 29.93 KB | +1.30 KB (+4.54%) |
domain.html |
99.93 KB | 101.20 KB | +1.28 KB (+1.28%) |
debugger.js |
29.57 KB | 30.81 KB | +1.24 KB (+4.20%) |
path.html |
130.38 KB | 131.59 KB | +1.21 KB (+0.93%) |
tracing.js |
77.70 KB | 78.86 KB | +1.16 KB (+1.49%) |
querystring.js |
31.67 KB | 32.80 KB | +1.12 KB (+3.55%) |
typescript.html |
52.72 KB | 53.74 KB | +1.02 KB (+1.93%) |
diagnostics_channel.js |
251.60 KB | 252.55 KB | +974.00 B (+0.38%) |
environment_variables.js |
15.69 KB | 16.61 KB | +939.00 B (+5.84%) |
documentation.js |
8.60 KB | 9.47 KB | +895.00 B (+10.16%) |
intl.html |
58.47 KB | 59.34 KB | +887.00 B (+1.48%) |
debugger.html |
52.50 KB | 53.32 KB | +839.00 B (+1.56%) |
report.js |
187.75 KB | 188.55 KB | +818.00 B (+0.43%) |
string_decoder.js |
31.45 KB | 32.25 KB | +816.00 B (+2.53%) |
wasi.html |
66.24 KB | 67.02 KB | +796.00 B (+1.17%) |
embedding.js |
36.43 KB | 37.18 KB | +764.00 B (+2.05%) |
punycode.html |
60.16 KB | 60.90 KB | +762.00 B (+1.24%) |
tracing.html |
82.01 KB | 82.72 KB | +723.00 B (+0.86%) |
diagnostics_channel.html |
213.45 KB | 214.06 KB | +624.00 B (+0.29%) |
querystring.html |
60.04 KB | 60.64 KB | +614.00 B (+1.00%) |
environment_variables.html |
42.93 KB | 43.49 KB | +572.00 B (+1.30%) |
string_decoder.html |
52.69 KB | 53.18 KB | +506.00 B (+0.94%) |
permissions.js |
27.89 KB | 28.37 KB | +489.00 B (+1.71%) |
documentation.html |
36.29 KB | 36.76 KB | +482.00 B (+1.30%) |
report.html |
175.11 KB | 175.58 KB | +480.00 B (+0.27%) |
embedding.html |
57.82 KB | 58.28 KB | +466.00 B (+0.79%) |
synopsis.js |
15.28 KB | 15.67 KB | +397.00 B (+2.54%) |
permissions.html |
55.88 KB | 56.18 KB | +312.00 B (+0.55%) |
synopsis.html |
42.07 KB | 42.30 KB | +234.00 B (+0.54%) |
index.html |
34.81 KB | 34.95 KB | +138.00 B (+0.39%) |
index.js |
9.40 KB | 9.48 KB | +87.00 B (+0.90%) |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a Table of Contents (TOC) component to the API documentation pages, enhancing navigation by displaying section headings alongside the main content.
Changes:
- Updated
@node-core/ui-componentsfrom version 1.5.3 to 1.5.6 to access the new TableOfContents component - Added TableOfContents component configuration to JSX_IMPORTS
- Integrated TableOfContents into the document layout, positioned before the main content area
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/generators/web/constants.mjs | Added TableOfContents import configuration; removed JSDoc type annotation |
| src/generators/jsx-ast/utils/buildContent.mjs | Integrated TableOfContents component into layout; updated JSDoc type references |
| package.json | Bumped @node-core/ui-components version to 1.5.6 |
| npm-shrinkwrap.json | Updated lockfile to reflect new ui-components version |
Files not reviewed (1)
- npm-shrinkwrap.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
|
@avivkeller I did just a small fix on the headings links |
ovflowd
approved these changes
Jan 24, 2026
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.
cc @araujogui