Next.js Engine — Documentation Index
These docs follow the current main-3 implementation unless a page explicitly describes an older release.
If a historical example conflicts with the current TypeScript source or a current component page, prefer the current source and current component page.
Start here
I want to… | Read |
|---|---|
Understand the current Gen 3 stack | |
Learn server-first | |
Learn schemas, props, and general page authoring | |
Learn styling and responsive props | |
Learn NENC, EngineCookies, sessions, replay/rate policy, and private backends | |
Learn compatibility manifests and fallback compilation | |
Understand EngineDebug ephemeral isolation | |
Generate metadata, sitemaps, robots, JSON-LD, and social previews | |
Generate Google/Bing/Yandex-aware XML sitemaps | |
Run the device-bound private-search proof | |
Read release history | |
Read the large historical technical reference |
Generation 3 stack
schema
↓
compilePage()
↓
execution plan
├─ static / server / client ownership
├─ critical / visible / near / deferred / idle / sleeping work
├─ used-feature manifest
├─ fallback plan
├─ assets
└─ diagnostics
↓
EngineServerRenderer
↓
small client islands only where browser behavior is required
↓
EngineScheduler + EngineViewport + EngineModel
↓
optional EngineCommand / NENC / EngineCookies / EngineServer boundaryThe normal Gen 3 page entrypoint is createPage(); a separate Gen 3 factory is not required.
Read gen3/overview.md first if you are starting a new page or migrating a v2 page.
Page and UI authoring
Topic | Documentation |
|---|---|
Schema primitives | |
Styling / responsive values | |
Navigation | |
Page and layout transitions | |
Heroes | |
Forms | |
Markdown | |
Suspense/loading surfaces | |
Overlay/dialog/drawer/popover | |
SEO, crawler routes, JSON-LD, and social previews | |
Search-engine-specific XML sitemaps |
Graphics and motion
Use the system that owns the job instead of forcing everything through one renderer.
EngineTransitions+
→ page/layout state changes
EngineScroll
→ scroll-driven movement and named points
EngineCanvas
→ retained/immediate graphics surface
EngineSVG
→ SVG rendering/import/export for ECScene
EngineShader
→ compiled GPU effects and .shed programs
EngineManim
→ higher-level animation/model choreographySystem | Documentation |
|---|---|
EngineCanvas | |
EngineSVG | |
EngineShader | |
EngineTransitions+ | |
EngineScroll | |
EngineManim | |
EngineImage / EngineVideo |
EngineTransitions+ and EngineShader remain separate responsibilities. Transition presets such as pixel, liquid, and dissolve are transition animations, not .shed framebuffer passes.
Browser/runtime systems
Topic | Documentation |
|---|---|
Scheduler + server-first compiler | |
Browser capabilities | |
Device/adaptive layout | |
Runtime/lazy/performance behavior | |
Schema validation and diagnostics | |
Compatibility/fallback compiler | |
EngineDebug ephemeral workbench isolation |
For styling-only responsive differences, prefer responsive schema values/CSS. Use EngineViewport or request-time adaptive compilation only when behavior or structure genuinely depends on live/request device state.
Network and backend systems
Topic | Documentation |
|---|---|
External API resolver and auth | |
Static in-house endpoint programs | |
NENC / EngineCookies / sessions / device proof | |
Private-search end-to-end example |
Browser-safe command/cookie APIs belong in nextjs-engine/network. Request-aware dispatch, CORS, session policy, and private backend helpers belong in nextjs-engine/server.
NENC is optional. Do not enable it merely because it exists; use it when the application has commands that benefit from the compiled single-endpoint boundary.
Release history and compatibility
The maintained release archive lives under docs/release.
Release notes describe the Engine as it existed at that release. They are not the API contract for main-3.
Version | Release notes |
|---|---|
v2.6.2 | |
v2.6.1 | |
v2.6.0 | |
v2.5.0 | |
v2.0.0 | |
v1.0.0 |
Abbreviations
Abbreviation | Module |
|---|---|
EC | EngineCanvas |
ESVG | EngineSVG |
ESH | EngineShader |
ET | EngineTransitions+ |
ES | EngineScroll |
EB | EngineBrowser |
EM | EngineManim |
EMD | EngineMarkdown |
EN | EngineNav |
EH | EngineHero |
ESU | EngineSuspense |
EF | EngineForms |
EA | EngineAPI |
EAS | APIStatic |
EMO | EngineMobile |
ED | EngineDevice |
NENC | Next.js Engine Network Commands |
ESEO | EngineSEO |