[good first issue] Add 5-minute self-host smoke checklist #74

New issue

Open

opened 2026-07-09 03:17:03 +00:00 by gmackie · 0 comments

gmackie commented

2026-07-09 03:17:03 +00:00

Owner

Why this is a good first issue

Small, reviewable README/docs PR. Teaches repo layout without requiring deep platform knowledge.

Goal

Add a 5-minute self-host smoke checklist under docs/ (suggested path: docs/self-host-smoke.md) that a cold reader can follow after cloning:

Install prerequisites (Nix, pnpm/Node versions from root package.json engines)
pnpm install / agent build smoke (cd agent && go build ...)
Point at a server (forge login or documented env)
Run forge doctor and interpret a green vs red result
Optional: deploy a sample app only if a non-prod stage is available (document "stop here" for pure doc readers)

Acceptance criteria

Checklist is copy-pasteable and time-boxed (~5 minutes for steps 1–4)
Explicitly marks which steps need a live ForgeGraph server vs local-only
Linked from root README.md Contributing / Development section
Does not hard-code production secrets or private hostnames beyond public examples already in README

References

README.md
docs/community/strategy.md launch sequencing (docs gate)
CONTRIBUTING.md

Labels

good first issue · docs · help wanted · community

## Why this is a good first issue Small, reviewable README/docs PR. Teaches repo layout without requiring deep platform knowledge. ## Goal Add a **5-minute self-host smoke checklist** under `docs/` (suggested path: `docs/self-host-smoke.md`) that a cold reader can follow after cloning: 1. Install prerequisites (Nix, pnpm/Node versions from root `package.json` engines) 2. `pnpm install` / agent build smoke (`cd agent && go build ...`) 3. Point at a server (`forge login` or documented env) 4. Run `forge doctor` and interpret a green vs red result 5. Optional: deploy a sample app **only if** a non-prod stage is available (document "stop here" for pure doc readers) ## Acceptance criteria - [ ] Checklist is copy-pasteable and time-boxed (~5 minutes for steps 1–4) - [ ] Explicitly marks which steps need a live ForgeGraph server vs local-only - [ ] Linked from root `README.md` Contributing / Development section - [ ] Does not hard-code production secrets or private hostnames beyond public examples already in README ## References - [`README.md`](README.md) - [`docs/community/strategy.md`](docs/community/strategy.md) launch sequencing (docs gate) - [`CONTRIBUTING.md`](CONTRIBUTING.md) ## Labels `good first issue` · `docs` · `help wanted` · `community`

gmackie added the

labels

2026-07-09 03:17:03 +00:00