-
Notifications
You must be signed in to change notification settings - Fork 6
feat(docs): builder docs rebuild — mechanics and spine (Phases 1-2) #795
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from all commits
e1d890e
26e2f6c
ade03f6
6c21a96
6b7d408
8861d88
79b499b
4730026
e8ba51d
aec28f1
8d5f74e
5da464d
efd3175
5ca66db
6cd031f
acb13e7
8d0202a
bb82479
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # audit | ||
|
|
||
| The repo-health check. Audit sweeps Green Goods for drift and decay: dead code, dependency health, stale guidance and plans, invariant drift, and concrete broken or brittle spots. It reads everything and changes nothing; accepted findings route to a fix pass, a cleanup run, or Linear. | ||
|
|
||
| **How to invoke:** Type `/audit` (or `/audit drift` for the quick drift classifier). | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # clean | ||
|
|
||
| Scope-locked cleanup at scale. Clean runs eight focused assessment lanes over the codebase (deduplication, type consolidation, dead code, circular dependencies, type strengthening, defensive-code removal, legacy cleanup, and AI-slop removal) and only changes what a human locked into scope first. | ||
|
|
||
| **How to invoke:** Type `/clean` after audit findings are accepted; `--dry-run` and `--scope` bound it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # debug | ||
|
|
||
| The bug entry point. Describe a bug, paste a stack trace, or report a failing build and this workflow fires on its own, then routes the work: reports from real users get reproduced first, urgent incidents take the hotfix lane, red tests get test-driven fixes, and QA slices get pulled from Linear. | ||
|
|
||
| **How to invoke:** No command needed; describing the problem activates it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # design | ||
|
|
||
| The keeper of the Warm Earth design language. Design holds the direction for shape, motion, color, and material tokens, the split between the admin cockpit and client PWA identities, and the review lenses for UI work. Reach for it before new views, polish passes, or prompts for AI design tools. | ||
|
|
||
| **How to invoke:** Loads by context for design-direction questions and UI work. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -196,8 +196,8 @@ A checklist agents run once per PR catches what we remember. Automated checks ca | |||||
|
|
||||||
| ## Related | ||||||
|
|
||||||
| - Regenerative rationale and sources: `docs/docs/reference/design-research.md` | ||||||
| - Regenerative rationale and sources: `docs/docs/builders/architecture/design.mdx` | ||||||
| - Spatial patterns: [surfaces.md](./surfaces.md) | ||||||
| - Ecosystem archetypes: [ecosystem.md](./ecosystem.md) | ||||||
| - Implementation details: [implementation.md](./implementation.md) | ||||||
| - Green Goods personas: `docs/docs/reference/design-research.md` | ||||||
| - Green Goods personas: `docs/docs/builders/architecture/design.mdx` | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Point the persona reference to the persona page.
Proposed fix- Green Goods personas: `docs/docs/builders/architecture/design.mdx`
+ Green Goods personas: `docs/docs/builders/reference/persona-surfaces.mdx`📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # doc-feedback | ||
|
|
||
| Turns a reviewed Google Doc into tracked work. Point it at a .docx export carrying comments and tracked changes and it parses the feedback into a triage-able record, then walks each item to resolution with a scope-lock gate between phases. | ||
|
|
||
| **How to invoke:** Type `/doc-feedback` once the team has finished reviewing a doc. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # module-seams-review | ||
|
|
||
| A deep, read-only review of module boundaries: public exports, dependency direction, composition roots, direct-test seams, and mock fidelity. Use it for import-boundary migrations and testability-architecture reviews, not for ordinary small diffs. | ||
|
|
||
| **How to invoke:** Describe a modules-and-seams review intent to activate it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # plan | ||
|
|
||
| Planning and execution for Green Goods. Plan creates structured implementation plans in `.plans` feature hubs, tracks lane state and proof, mirrors visibility to Linear, and coordinates agent teams when they are explicitly requested. | ||
|
|
||
| **How to invoke:** No slash command; planning intent ("plan this", "break down X") activates it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # qa-session | ||
|
|
||
| Live product QA with fixes in the loop. Run it during a walk of the product (paired, live, or from a transcript) and it captures stable records, triages bounded fix-now work, revalidates in the serving checkout, and hands deferred findings to qa-triage with exact test IDs. | ||
|
|
||
| **How to invoke:** Type `/qa-session` or announce a QA walk. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # qa-triage | ||
|
|
||
| Turns QA notes into tracked records. After a Build Sync or a qa-session handoff, it enriches findings against PostHog and existing Linear records, then files scope-locked issues and private QA-sheet rows, and it writes only after confirmation. | ||
|
|
||
| **How to invoke:** Type `/qa-triage` after a QA call or handoff. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # research | ||
|
|
||
| Evidence-first answers before decisions. Research reconciles repository and primary-source evidence for a bounded question, labels every conclusion by how established it is, and returns a brief that drives the next decision. It is read-only by default. | ||
|
|
||
| **How to invoke:** Describe the bounded question; research intent activates it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # resolve-pr-comments | ||
|
|
||
| Works a pull request's review feedback to done. It validates each unresolved thread, sweeps for related instances, fixes with targeted proof, and pushes through the gate. GitHub replies and thread resolution happen only with explicit authorization. | ||
|
|
||
| **How to invoke:** Ask to address or resolve a PR's review comments. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # review | ||
|
|
||
| The full change review. Review hunts regressions, remaining gaps, and production quality in one pass over a PR, branch, or working copy, and returns severity-ordered findings with validation evidence and a verdict. | ||
|
|
||
| **How to invoke:** Type `/review [package|PR|path]`. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # ship | ||
|
|
||
| Publication without ceremony. Ship proves the changed behavior locally, runs the budgeted push gate, and lets GitHub CI own broad regression coverage; the complete local gate is reserved for releases, critical surfaces, and explicit full-local requests. | ||
|
|
||
| **How to invoke:** Commit, push, or PR intent activates it. | ||
|
|
||
| [`SKILL.md`](./SKILL.md) in this folder is the executable contract; this README is the human | ||
| summary the [Skills Catalog](https://docs.greengoods.app/builders/agentic/skills) projects. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Builder Docs Rebuild — Brief | ||
|
|
||
| **Feature Slug**: `builder-docs-rebuild` | ||
| **Status**: ACTIVE | ||
| **Created**: 2026-09-02 | ||
| **Owner**: Afo (decisions) / Claude (execution) | ||
|
|
||
| ## Problem | ||
|
|
||
| The builder track at docs.greengoods.app (45 pages) was authored in the repository's | ||
| agent-contract register: 29 pages under 220 words, ~5,900 hand-written words total, zero external | ||
| links at research time, entry pages that defer to repo files instead of teaching, and seven of ten | ||
| sidebar categories fronted by empty auto-generated index pages (which also breaks the teal accent). | ||
| A 2026-09-01 review meeting rated the track "context-poor, not human-friendly, no flow, no links." | ||
|
|
||
| ## Outcome | ||
|
|
||
| A clear, human-friendly technical guide for developers who want to understand, explore, test, or | ||
| contribute to Green Goods: ~38 fuller pages in 8 sections, every category fronted by a real landing | ||
| page, hand-written prose in the community track's register, generated projections kept and | ||
| digest-gated, external links everywhere they teach, and the whole site agent-readable | ||
| (`llms.txt` + `.md` twins). | ||
|
|
||
| ## Blueprint | ||
|
|
||
| The full research brief and page-by-page dispositions live in the review artifact | ||
| ("Builder Docs Rebuild", rev 2 — private link, decisions D1–D10 locked with Afo on 2026-09-02): | ||
| https://claude.ai/code/artifact/3f55d286-fca3-4d50-b032-d8e61001268a | ||
|
|
||
| `spec.md` in this hub carries the durable subset: target IA, locked decisions, page templates, | ||
| and tone contract. Research basis: reference-site evidence packs (GainForest, EAS, Hats, Octant), | ||
| Diátaxis, Google developer style highlights, Write the Docs, and a full local inventory. | ||
|
|
||
| ## Constraints | ||
|
|
||
| - Keep the docs trust machinery: generators, digest gates (`check:docs-generated`), | ||
| `source_of_truth` frontmatter, `docs:audit:ci`. | ||
| - The `feature/qa-report` stream owns the QA pages (rewritten 2026-09-01/02, merged in #793); | ||
| this effort only aligns links and placement around them. | ||
| - No big-bang: each phase is an independently shippable PR to `develop`; the site is never worse | ||
| mid-migration. Moved or deleted slugs always get redirects. | ||
| - Root-scripts consolidation (240 scripts) is explicitly out of scope (D6, separate follow-up). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On a clean checkout, or after clearing generated output, this launch configuration starts a server whose routes all return 404 because
docs/buildis ignored and setup does not create it.docusaurus serve --helpdocuments that its--buildoption defaults to false, and running the configured command against an absent output directory reproduced the all-404 server. Add--buildor use the development server so the one-click launcher works without a prior undocumented build.Useful? React with 👍 / 👎.