mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-19 03:12:21 +02:00
docs: update project documentation for v1.82.0.0
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5.1
parent
9b2218a40b
commit
763671f7c3
@@ -106,8 +106,11 @@ engine) plus the `/browse` skill, `design/` design binary, `make-pdf/` PDF
|
||||
binary, `hosts/` typed host configs, `scripts/` build+DX tooling
|
||||
(gen-skill-docs, resolvers — `resolvers/aside.ts` is the Aside contract),
|
||||
`test/` validation+evals, `lib/` shared libraries (`aside-render.ts` renders
|
||||
local HTML through Aside, falling back to the engine), `bin/` CLI utilities
|
||||
(`gstack-render.ts` is the render CLI skills call), `extension/` Chrome
|
||||
local HTML through Aside, falling back to the engine; `design-catalog.ts` is
|
||||
the typed design anti-pattern catalog every design skill renders from), `bin/`
|
||||
CLI utilities (`gstack-render.ts` is the render CLI skills call;
|
||||
`gstack-design-detect.ts` and `gstack-design-md.ts` are the design detector
|
||||
and open-DESIGN.md tools), `extension/` Chrome
|
||||
extension, one directory per skill (`ship/`, `review/`, `qa/`, ...),
|
||||
`.github/` CI, `contrib/` contributor tools, `docs/designs/` design documents.
|
||||
|
||||
@@ -119,6 +122,13 @@ SKILL.md files are **generated** from `.tmpl` templates. To update docs:
|
||||
2. Run `bun run gen:skill-docs` (or `bun run build` which does it automatically)
|
||||
3. Commit both the `.tmpl` and generated `.md` files
|
||||
|
||||
The same `gen:skill-docs` run writes two more generated files from `lib/`:
|
||||
`review/design-checklist.md` (from `lib/design-catalog.ts`, through
|
||||
`scripts/resolvers/design-checklist.ts`) and `lib/dom-dump.js` (from
|
||||
`lib/dom-dump-script.ts`). Edit the catalog or the script source, regenerate,
|
||||
and commit both; never edit the generated file
|
||||
(`test/design-checklist-sync.test.ts` fails on drift).
|
||||
|
||||
Generation uses each host's `defaultModel` (`claude` for existing hosts, `gpt`
|
||||
for Codex) unless `--model` is explicit. Codex installs additionally read the
|
||||
top-level model from `${CODEX_HOME:-~/.codex}/config.toml`; rerun
|
||||
|
||||
Reference in New Issue
Block a user