ReviewOS

also looking at this

stacks/commshq

Add BunPress guide and pre-E2E quality gates

#6
Merged glennmichael123 wants to merge docs/bunpress-product-guide into main
318 files +2174 -70006

Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.

README.mdmodified+4-1
Changes to README.md
@@ -19,10 +19,13 @@ CommsHQ requires Bun 1.3 or newer and uses only packages owned by the Stacks eco
1919
2020```bash
2121bun install
22./buddy migrate:fresh --seed
22./buddy migrate --auth
23./buddy seed
2324./buddy dev
2425```
2526
27Set `COMMSHQ_OWNER_PASSWORD` in your local `.env` before seeding so the owner account and workspace are created. `./buddy migrate:fresh --seed` drops all tables and is only for a disposable development database.
28
2629Run the full local quality gate with:
2730
2831```bash
docs/getting-started.mdmodified+7-2
Changes to docs/getting-started.md
@@ -17,11 +17,16 @@ description: Run CommsHQ locally and learn the first end-to-end workflow.
1717git clone https://github.com/stacksjs/commshq.git
1818cd commshq
1919bun install
20./buddy migrate:fresh --seed
20./buddy migrate --auth
21./buddy seed
2122./buddy dev
2223```
2324
24The seeded database supplies representative contacts, segments, campaigns, content, automations, commerce events, and reputation data.
25Set `COMMSHQ_OWNER_PASSWORD` to a password you choose in your local `.env` before running `./buddy seed`. You can also set `COMMSHQ_OWNER_EMAIL`; otherwise the owner seeder uses `chris@stacksjs.com`. Without the password, the owner seeder skips account and workspace creation outside production, so there is no owner account to sign in with. In production it fails instead of creating an account with an empty password.
26
27The model seeders can create sample records, but they do not replace the owner bootstrap or prove that every workflow below is connected in the dashboard. Start by signing in with the owner account you configured, then inspect the seeded workspace and available API surfaces.
28
29`./buddy migrate:fresh --seed` drops every table. Use it only when you deliberately want to reset a disposable development database, not as the normal setup path for an existing checkout.
2530
2631## Learn one complete flow
2732
docs/index.mdmodified+1-1
Changes to docs/index.md
@@ -24,7 +24,7 @@ features:
2424
2525## Choose a path
2626
27- Use the [quick start](/getting-started) to run CommsHQ and inspect the seeded workspace.
27- Use the [quick start](/getting-started) to create an owner workspace and inspect the available sample data.
2828- Establish clean identity and permission data with [contacts and consent](/audience/contacts-consent).
2929- Build an audience with [segments and imports](/audience/segments-imports).
3030- Learn the delivery lifecycle in [email and SMS campaigns](/campaigns/email-sms).