Files
stack/docs/USER-GUIDE/README.md
T

2.5 KiB

User Guide

Status: Scaffold only. No legacy page has been promoted into this book yet.

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

Chapter map

Chapter Scope Status
getting-started/ First-use setup, orientation, and quickstarts. Scaffold only; QUICKSTART.md is the migration candidate.
concepts/ User-facing terminology, product concepts, and mental models. Scaffold only.
workflows/ Task-oriented procedures for using Mosaic Stack. Scaffold only.
troubleshooting/ User-visible failures, diagnostics, and fixes. Scaffold only.

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:

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.