Documentation model

This page is the operating model for public FluxonLab docs. It keeps FlowHub, Prompt Studio, Blog, Labs, and the main FluxonLab site in one navigable structure while preserving app-specific runbooks.

Canonical locations

Content type	Location	Rule
Public cross-product docs	apps/web/src/content/docs	EN at the collection root, DE under de/, TR under tr/.
Internal site/media/research plans	docs/	Keep planning, migration, and damage reports out of public navigation.
Blog editorial runbooks	apps/blog/docs	Keep operator runbooks there unless they need public reference.
Tool README files	Tool folder README.md	Keep setup notes close to the tool, then link from public docs if user-facing.

Navigation groups

• Start here — orientation, quickstart, status and access.
• Products — individual product guides across the roster, with honest status labels.
• Platform surfaces — FlowHub, Prompt Studio, Labs, Blog, and the FluxonLab site.
• Reference — privacy, security, prompt/media rules, troubleshooting, glossary.
• Operations — docs model, release checks, commit/push autonomy, contributor rules.
• About — principles, FAQ, support.

Product page template

Every public platform/product page should answer the same questions:

1. Status — live, split, building, coming soon, planned, or internal.
2. What it is — one plain-language purpose.
3. Who it is for — primary users and workflows.
4. Current capabilities — only what exists now.
5. Access and availability — public route, gated account, or honest coming-soon note.
6. Operating boundaries — what it does not do, especially execution, credentials, spend, and publication.
7. Verification — the local command that proves the path still builds or validates.
8. Related docs — links into status, security, and relevant product pages.

Frontmatter

The docs schema accepts these optional operating fields:

status: preview
owner: docs-platform
lastReviewed: 2026-07-07
appliesTo: ["flowhub", "prompt-studio"]

Visible docs still need real body text; frontmatter is a routing and maintenance aid, not a substitute for explanation.

Localization rule

EN is canonical for authoring. DE and TR mirrors must be real translations with the same status, scope, and warnings. Do not publish a new public docs page in only one language unless it is marked draft: true.

Honesty rule

No docs page may claim a feature is live unless the app route, build path, or operational runbook exists. Use planned, preview, or internal language when a capability is not open yet.

Verification

Run both public docs builds after structural docs changes:

npm --prefix apps/web run build
npm --prefix apps/blog run ci:blog