mosaicstack/stack
1
0
Fork 1
Code Issues 246 Pull Requests 7 Actions Packages Projects Releases 15 Wiki Activity

docs: create user quickstart

Browse Source
This commit is contained in:
Jason Woltje
2026-08-10 16:40:14 -05:00
parent bcd174f89e
commit 571a3d54b5
6 changed files with 153 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/USER-GUIDE/README.md
+13 -9
View File
@@ -1,6 +1,6 @@
# User Guide
> **Status:** Scaffold only. No legacy page has been promoted into this book yet.
> **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/).
@@ -8,16 +8,20 @@ This book is the canonical home for end-user workflows, user-visible behavior, p
- [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 candidate](../QUICKSTART.md) — currently empty; it is not yet a usable guide.
- [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. | 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. |
| 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.
@@ -26,7 +30,7 @@ Every promoted page must be added to this index and to [`SITEMAP.md`](../SITEMAP
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.
- [`QUICKSTART.md`](../QUICKSTART.md) — incomplete zero-byte placeholder.
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.