OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

platform.docs/docs.meta.docblocks-process

  • Colocate docs beside implementation; avoid barrel /docs folders.
  • Split intent:
  • goal: why this exists (before implementation).
  • how: operational/runbook steps.
  • usage: quick checklist for consumers.
    • field.key.label
    platform.docs/docs.meta.docblocks-process
    field.version.label
    field.type.label
    field.title.label
    platform.docs/docs.meta.docblocks-process
    field.description.label
  • Colocate docs beside implementation; avoid barrel /docs folders.
  • Split intent:
  • goal: why this exists (before implementation).
  • how: operational/runbook steps.
  • usage: quick checklist for consumers.
    • field.tags.label
    field.owners.label
    field.stability.label

    DocBlocks authoring rules

    •

    Colocate docs beside implementation; avoid barrel /docs folders.

    •

    Split intent:

    •

    **goal**: why this exists (before implementation).

    •

    **how**: operational/runbook steps.

    •

    **usage**: quick checklist for consumers.

    •

    Use `visibility`: public | internal | mixed.

    •

    Prefer routes like `/docs/<domain>/<topic>/<kind>`; ids mirror that.

    •

    Keep body Markdown LLM-friendly; avoid HTML.

    •

    Add owners/tags/domain/stability when known.

    •

    For presentations/markdown outputs, rely on TransformEngine via DocRegistry.

    •

    No sourcePath; DocBlocks are canonical.