Files
stack/docs/USER-GUIDE/README.md
T
veronica f0d2dd9920 docs(W4): stamp kind and status front matter on 104 live documents
Applies the document contract from
docs/plans/2026-08-20_stack-docs-flatten-and-alignment.md section 3, partially:
`kind` and `status` only. `parent` is deliberately held until the flatten in
section 4 lands, so that 127 documents do not have to be re-pointed by hand
when docs/fleet/NORTH_STAR.yaml moves to docs/NORTH_STAR.yaml.

Scope, measured on origin/next at 63069149:

  127 live docs   = all *.md under docs/ minus docs/archive/ minus docs/_old_structure/
  104 stamped     here
   19 held        operator judgement (plan section 9), worklist in the same PR
    3 held        the SUPERSEDED TASKS.md stamps, which cite the moving path
    1 untouched   docs/fleet/FLEET-DOCTRINE.md, already stamped in W1

Kinds applied: 54 guide, 34 record, 9 spec, 6 tracking, 1 projection.
Every row carries a confidence and a one-line rationale in the worklist.

Two collisions with the existing state, both flagged rather than resolved:

1. docs/README.md:150-160 already documents a front-matter convention
   (title/type/audience/status/source_of_truth) with its own allowed values.
   It is applied to 4 of 127 files. Its `status` vocabulary is
   current|draft|deprecated|historical; the new contract's is active|superseded-by.
   The key collides. This commit lets the new contract win and rewrites
   `status: current` to `status: active` on those 4 files, keeping their other
   legacy keys untouched. No code reads any of them: `git grep source_of_truth`
   outside docs/ returns nothing. docs/README.md still prescribes the old
   convention and is an operator row, so it is not edited here.

2. Two of the plan's 20 operator rows are YAML files, not markdown
   (docs/fleet/examples/roster-v2.yaml, docs/openapi-tess.yaml), and the
   contract's front-matter form has no defined meaning for a .yaml document.
   That gap also applies to docs/fleet/NORTH_STAR.yaml, the source of truth
   itself. Raised in the worklist.

A third row from the plan, docs/fleet/north-star.md, no longer exists: W1
renamed it to docs/fleet/FLEET-DOCTRINE.md.

Verification: 104/104 parse with the expected kind and status in front matter;
the check was shown to reject a wrong kind before it was trusted. The diff
removes 4 lines total, all of them `status: current`.
2026-08-20 19:30:25 -05:00

3.4 KiB

kind, status
kind status
guide active

User Guide

Status: Partially migrated. The quickstart, web-dashboard reference, and Discord conversation workflow are current.

This book is the canonical home for end-user workflows, user-visible behavior, product concepts, and user troubleshooting. Keep installation, deployment, security controls, and recovery procedures in ADMIN-GUIDE/; keep implementation detail in DEVELOPER-GUIDE/.

Start here

  • Documentation atlas — placement rules and source-of-truth boundaries.
  • Documentation sitemap — resolvable current navigation and authority-gated migration summary.
  • Quickstart — install Mosaic, complete setup, and launch a session.
  • Web dashboard — current routes, navigation, chat persistence, projects/tasks views, settings, and admin behavior.
  • Discord conversations — current authorized parent-channel, thread, attachment, and control workflow.

Chapter map

Chapter Scope Status
getting-started/ First-use setup, orientation, and quickstarts. Quickstart is current; additional pages are planned.
concepts/ User-facing terminology, product concepts, and mental models. Scaffold only.
workflows/ Task-oriented procedures for using Mosaic Stack. Discord conversation workflow is current.
product/ Current product surfaces and visible behavior. Web dashboard reference is current.
troubleshooting/ User-visible failures, diagnostics, and fixes. Scaffold only.

Current pages

Every promoted page must be added to this index and to SITEMAP.md in the same migration slice.

Migration backlog — not current navigation

These are source candidates, not current user guidance:

  • _old_structure/guides/user-guide.md — quarantined historical source; verify every claim before promotion. See the documentation catalog for its disposition.
  • The former root QUICKSTART.md was an empty placeholder and has been replaced by the current page above.

Do not link to the quarantine as a current user path. Create a new page only after classifying its audience, status, and evidence in the migration report.

Authoring boundary

New user-facing documentation belongs under one of the chapter directories above. Use a lowercase kebab-case page name, state whether commands are current or held, and link back to this index plus related canonical sources.