feat: add preview:docs & preview:node scripts

[btea]

Description

Add a unified startup preview script to facilitate quick previewing and verification of changes on the page after modifying the code logic.

Validation

Related Issues

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run node --run test and all tests passed.
• I have check code formatting with node --run format:check & node --run lint.
• I've covered new added functionality with unit tests if necessary.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
api-docs-tooling	Ready	Preview	Oct 18, 2026 2:00am UTC

[codecov]

Codecov Report

❌ Patch coverage is 0% with 140 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.98%. Comparing base (560c042) to head (0f5b7dc).

Files with missing lines	Patch %	Lines
scripts/preview.mjs	0.00%	140 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1082      +/-   ##
==========================================
- Coverage   93.44%   92.98%   -0.47%     
==========================================
  Files         278      279       +1     
  Lines       27815    27955     +140     
  Branches     2789     2789              
==========================================
  Hits        25993    25993              
- Misses       1800     1940     +140     
  Partials       22       22              

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

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

api-links Generator

Performance estimate _{(single CI run)}

• Generation time: 63.1% slower (650.00 ms → 1.06 s)
• Peak memory: 2.5% lower (302.18 MB → 294.71 MB)

json Generator

Performance estimate _{(single CI run)}

• Generation time: 27.3% slower (7.48 s → 9.52 s)
• Peak memory: 5.1% lower (1.21 GB → 1.14 GB)

legacy-html Generator

Performance estimate _{(single CI run)}

• Generation time: 13.2% faster (14.67 s → 12.74 s)
• Peak memory: 2.9% higher (1.84 GB → 1.89 GB)

legacy-json Generator

Performance estimate _{(single CI run)}

• Generation time: 52.4% slower (5.82 s → 8.87 s)
• Peak memory: 5.7% lower (1.26 GB → 1.19 GB)

llms-txt Generator

Performance estimate _{(single CI run)}

• Generation time: 13.2% slower (7.57 s → 8.57 s)
• Peak memory: 1.0% higher (1.14 GB → 1.15 GB)

orama-db Generator

Output size: 1 file changed · net -121.00 B

File size details

File	Main	PR	Change
orama-db.json	29.15 MB	29.15 MB	-121.00 B (-0.0%)

Performance estimate _{(single CI run)}

• Generation time: 5.1% faster (5.65 s → 5.36 s)
• Peak memory: 1.8% higher (1.33 GB → 1.35 GB)

web Generator

Performance estimate _{(single CI run)}

• Generation time: 4.6% faster (24.88 s → 23.73 s)
• Peak memory: 4.4% lower (2.04 GB → 1.95 GB)

[ovflowd]

Out of curiosity, is this meant to facilitate local development? I think in the past we decided against such scripts. I do believe we could make instructions easier tho.

[btea]

Yes, modifying the code locally and then validating it on the page requires building the latest code and starting a service. This process is quite cumbersome and involves many parameters, so I'm thinking of adding a script to simplify the process.

[bmuenzenmeyer]

I've come around to this after observing a mentee interact with this repository. There is a lot of intimidating work to get all this to work together, and for the unfamiliar, it's a lot.