Skip to content

Commit a71f06d

Browse files
TMHSDigitalclaude
andcommitted
docs: starter stacks in the site README and contributing guide
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wc67NX9MM964uaVGn4bpZJ
1 parent af137c3 commit a71f06d

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ One new markdown file is enough — the website rebuilds from frontmatter on dep
3636
11. Add a row to the matching category `README.md`. This is required: the validator fails an entry that is not listed there, and the row's licence cell must match your frontmatter.
3737
12. Optional: add the `id` to `site/config.json` → `featured` to pin it under Safe starting points.
3838

39+
To add a starter stack (one pick per need for a kind of game), follow [`stacks/README.md`](stacks/README.md).
40+
3941
### Frontmatter rules
4042

4143
- `license`: the source's licence, written as one of the values in [`site/license-vocabulary.json`](site/license-vocabulary.json) (e.g. `CC0`, `CC-BY-3.0`, `SIL OFL`, `GPL-3.0-or-later`, `custom`, `varies`). If the source uses a licence the vocabulary lacks, add it there first, with its SPDX mapping and attribution class. For GPL, record `-only` or `-or-later` only when the project itself says which; otherwise use the bare `GPL-2.0` or `GPL-3.0`.

‎site/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Static GitHub Pages UI for this catalog.
1313
| `site/config.json` → `categories` / `guides` | Labels and guide links |
1414
| `site/public/*` | Page chrome / design |
1515
| An entry's body (Notes, Evidence) | Its page at `entry/<id>/` |
16+
| `stacks/<id>.md` | Its page at `stack/<id>/`, the homepage Starter stacks list, and "Used in" on each picked entry |
1617

1718
## Public JSON
1819

@@ -46,6 +47,15 @@ The build also writes `llms.txt` (one line per entry) and `llms-full.txt` (with
4647
entry's Notes) for AI assistants, and checks every generated page before it succeeds.
4748
Tests: `node site/lib/lib.test.mjs`.
4849

50+
## Starter stacks
51+
52+
`build.mjs` writes `stack/<id>/index.html` for each file in `stacks/` (the format is in
53+
`stacks/README.md`). The page's "What this stack owes" panel is computed from the picked
54+
entries: credit lines to ship, picks that need no credit, aggregators to check file by
55+
file, and open questions. A stack never states a licence itself. V15 in `checks.mjs`
56+
fails a stack whose pick is missing, deprecated or malformed, or whose why sentence
57+
names a licence; `validate.mjs` and `build.mjs` both run it.
58+
4959
## Social preview
5060

5161
`docs/images/readme/og-card.png` is a 1200x630 screenshot of this site's first screen.

0 commit comments

Comments
 (0)