Skip to content

Rewrite the FSE templating documentation for the runtime-cached model #137

Description

@kuuak

Parent

#132

What to build

Bring the FSE templating documentation in line with the runtime-cached model.

The current document describes a two-phase system — build time generates a snapshot file, request time reads it — and that framing becomes wrong the moment the snapshot moves to runtime. Its architecture diagram, its mermaid schema, its build-script section, and its "Updating the JSON" guidance all describe a system that no longer exists. Leaving them in place is worse than having no documentation, because they read as authoritative.

The rewritten document should describe: how the snapshot is built and cached, how it is invalidated, what still resolves at request time and why (dynamic block data and navigation inner blocks), how translated template parts are handled, and how to dump the snapshot when debugging.

The distinction between invalidation (cheap, O(1)) and warming (expensive, per-page) is worth stating explicitly — it is the conceptual core of the new model and the source of the design's scaling properties.

Acceptance criteria

  • No remaining references to build-time snapshot generation or the dev/build lifecycle hooks
  • The invalidation flow is documented, including what triggers it from WordPress
  • The debug dump workflow is documented
  • Guidance on what does and does not require invalidation is accurate — notably that navigation menu edits do not
  • Diagrams reflect the runtime model

Blocked by

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationready-for-agentTicket is scoped and ready for an agent session to pick up

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions