Devflare Docs
Docs model Quickstart

See how the site model and published stay aligned

The documentation site now owns the authored docs model, while remains the generated one-file export shipped with the package.

The older split handbook content has been folded into . The site now carries that material as smaller task-focused routes, and the published file is generated from the same model when you want one flattened handbook export.

Authoritative authoring layer
Primary reading surfaces
Task-focused routes plus and exports
Refresh commands
from , or the same command from when you also want the packaged copy refreshed

Know which layer is authoritative now

The structured documentation model in is now the source of truth for the authored Devflare handbook. The older split package docs have been folded into that model so the site and exported handbook stay aligned.

The site breaks that material into smaller task-focused routes, while the generated handbook turns the same model into one-file exports for search, review, and package shipping.

The generated export is the fuller one-file handbook, while is the stricter text-oriented subset from the same model and intentionally omits handbook-only sections such as the documentation contract. The published file is copied from before packaging, and none of those exports are meant to be hand-edited source authoring.

Structured docs model

now holds the authored handbook copy, page structure, examples, and task-first route organization.

Task-focused site routes

The site favors smaller routes aimed at one job to be done instead of mirroring the old handbook structure page for page.

Published handbook export

Use for the fuller generated handbook, for the stricter text-oriented subset, and remember that is copied from before publish time.

The safest drift rule

If handbook coverage changes, update the matching site pages first, then regenerate the package handbook. If says something the site model does not back up, fix the site model and regenerate instead of patching the handbook by hand.

See where the same docs model shows up

The site and handbook outputs are different reading surfaces backed by one model, not separate sources of truth.

SurfaceBest whenBacked by
/docs/* routesYou are reading one topic in the site and want navigation, context, and examples inline.
/llm.md and /llm.txtYou want the generated handbook as one file: for the fuller export, for the stricter text-oriented subset that omits handbook-only sections such as the documentation contract.Generated from the same docs model.
You want the published one-file handbook that ships with the package.Copied from the generated docs export before packaging.

Use the site for tasks and the handbook for one-file reading

  1. 1

    Start from the task-focused site page when you need to build, review, or debug one specific part of Devflare.

  2. 2

    Use when you want the fullest one-file handbook, when you want the stricter text-oriented subset, or the published file when you want the package copy that ships.

  3. 3

    Run from when you are editing the site model, or from when you need the packaged copy refreshed too.

  4. 4

    Let build and prepare hooks regenerate the handbook outputs instead of hand-editing .

The intended reading pattern

Read the site by job to be done, and use the package-level when you want the same material in one file.

A good docs drift check is small and specific

  • Update the site pages first, then regenerate the handbook outputs.
  • If the site and disagree, fix and regenerate instead of patching the export by hand.
  • If a concept stops fitting the current site structure, add or split a page instead of hiding the change in generated output.
  • Never hand-edit generated ; regenerate it from the site model after you update the underlying docs.

Next

Why Devflare

Devflare gives you one clearer story for config, worker compilation, local development, runtime helpers, testing, and deploy flows so a Worker app can stay small at the start and still stay coherent as it grows.