Skip to content

Reduce API reference prerender memory#700

Merged
JamesW1 merged 4 commits into
mainfrom
bry/reduce-api-ref-memory
Jun 2, 2026
Merged

Reduce API reference prerender memory#700
JamesW1 merged 4 commits into
mainfrom
bry/reduce-api-ref-memory

Conversation

@bryantgillespie
Copy link
Copy Markdown
Member

@bryantgillespie bryantgillespie commented Jun 1, 2026

Changes

  • Generates API reference nav/meta plus one derived payload per OpenAPI tag before build/dev, keeping generated files out of git.
  • Switches the API layout to generated nav/meta only; each tag page loads only its generated payload via import.meta.glob.
  • Keeps client hydration while moving ref resolution, schema flattening, response example generation, and route list creation out of page render.
  • Keeps the lighter inline markdown renderer for plain API descriptions.
  • Deletes the now-orphaned runtime OpenAPI walkers/types/constants so the generator is the single source for API payload shaping.
  • Fails loudly if generated API prerender routes are missing/empty instead of silently prerendering zero API pages.

Potential Risks

  • Generated API payloads must exist before Nuxt starts; build/dev/generate/postinstall now run scripts/generate-api-reference.ts first.
  • The RSS number below is whole-process build RSS, not JS heap. It includes both the inline markdown reduction and generated per-tag payload path.

Review Notes

  • Verified pnpm typecheck:scripts.
  • Verified /usr/bin/time -l pnpm build; prerender completed 1073 routes with max RSS 6516359168 bytes locally.
  • Build output confirms generated API payloads split into separate chunks, e.g. users-BQDrUbI0.mjs 88.7 kB, fields-Bt4Ud968.mjs 47.4 kB, meta-BPhtIzF4.mjs 31.8 kB, plus _tag_ route chunk.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 1, 2026 9:43pm

Request Review

@JamesW1 JamesW1 marked this pull request as ready for review June 2, 2026 11:08
@JamesW1 JamesW1 requested a review from a team as a code owner June 2, 2026 11:08
@JamesW1 JamesW1 merged commit c55bf0d into main Jun 2, 2026
2 checks passed
@JamesW1 JamesW1 deleted the bry/reduce-api-ref-memory branch June 2, 2026 11:09
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.

2 participants