45 lines
2.6 KiB
Markdown
45 lines
2.6 KiB
Markdown
# User Guide
|
|
|
|
> **Status:** Initial migration active. The quickstart is current; additional user pages remain to be migrated.
|
|
|
|
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/`](../ADMIN-GUIDE/); keep implementation detail in [`DEVELOPER-GUIDE/`](../DEVELOPER-GUIDE/).
|
|
|
|
## Start here
|
|
|
|
- [Documentation atlas](../README.md) — placement rules and source-of-truth boundaries.
|
|
- [Documentation sitemap](../SITEMAP.md) — existing navigation is transitional and still contains legacy paths.
|
|
- [Quickstart](getting-started/quickstart.md) — install Mosaic, complete setup, and launch a session.
|
|
|
|
## 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. | Scaffold only. |
|
|
| `troubleshooting/` | User-visible failures, diagnostics, and fixes. | Scaffold only. |
|
|
|
|
### Current pages
|
|
|
|
- [Quickstart](getting-started/quickstart.md) — the verified installed-CLI first-use path.
|
|
|
|
Every promoted page must be added to this index and to [`SITEMAP.md`](../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`](../_old_structure/guides/user-guide.md) — historical source; verify every claim before promotion.
|
|
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.
|
|
|
|
## Related
|
|
|
|
- [[README|Documentation contract]]
|
|
- [[PRD|Product requirements]]
|