Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .agents/skills/docs-governance/LIFECYCLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ Preserve cited anchors / rule numbers; if renumbering is unavoidable, update eve

**The `apps/docs` docs site (built with Blume) is the canonical public documentation** for concepts, API, guides, examples, and adapter detail. Package `README.md` files and the repo root `README.md` are **npm/repo landings only**: package name, brand one-liner, experimental disclaimer (verbatim per docs-voice), install command, peer dependency, one idiomatic taste snippet, and links to the docs site — they **must not** restate API tables, when-to-use matrices, lifecycle explanations, or feature lists. Maintainer-facing depth stays in `docs/architecture.md`, `docs/glossary.md`, and the docs site `/reference/*`. On API changes, update the docs site first (`update-docs`); READMEs change only when install/peers/package name change.

PR checklist: docs site updated for behavior/API; READMEs touched only for install/taste/links.
PR checklist: docs site updated for behavior/API; READMEs touched only for install/taste/links. Label the PR **`docs`** when it changes `apps/docs/**` (or site-visible root/package README branding) — merge then deploys `/layers` via `.github/workflows/deploy-docs.yml` (also `release` / `workflow_dispatch`). Not GitHub's default `documentation` label.
2 changes: 1 addition & 1 deletion .agents/skills/docs-governance/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Repo-wide Tier B surface (cross-cutting reference + lifecycle substrate). This i

## Quick rules

Full blueprint: [LIFECYCLE.md](./LIFECYCLE.md) — the shared spine (§1–6: lifecycle types → cross-reference preservation), README surfaces (the `apps/docs` docs site is canonical; package + root READMEs are npm landings only), + Closing states (plans / audits / research). This is a small library — no per-feature `docs/` subtrees, no ownership tables.
Full blueprint: [LIFECYCLE.md](./LIFECYCLE.md) — the shared spine (§1–6: lifecycle types → cross-reference preservation), README surfaces (the `apps/docs` docs site is canonical; package + root READMEs are npm landings only; **`docs` label** on site-touching PRs for FTP deploy), + Closing states (plans / audits / research). This is a small library — no per-feature `docs/` subtrees, no ownership tables.

## Reference

Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/update-docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Upstream workflow: [`npx skills add haydenbleasel/blume --skill blume-update-doc
3. **Map changed surfaces to docs pages** — trace diffs in `packages/core/src`, `packages/*/src` exports, `blume.config.ts`, and CLI to the pages that document them (`content/reference/core-api.mdx`, `content/reference/adapter-hooks.mdx`, `content/adapters/**`, `content/guides/**`, plus related examples/recipes when behavior changed). _Done: every changed public surface mapped to zero or more docs pages._
4. **Edit only drifted facts** — signatures, option tables, behavior descriptions. Use `<AutoTypeTable>` where types changed (regenerates from source); do not rewrite stable prose. _Done: every drifted fact updated; no stable prose touched._
5. **Verify** — `bun run docs:validate -- --strict && bun run docs:check -- --isolated && bun run docs:build`; fix until green. **Do not commit if any fail.** Per [`verify-after-each-step`](../../rules/verify-after-each-step.md). _Done: all three green._
6. **Open or update a PR** on branch `blume/sync-docs-<date>` with a summary of what drifted and the fixes. Follow commit/PR conventions; never `--no-verify` ([`no-bypass-hooks`](../../rules/no-bypass-hooks.md)). _Done: PR open with drift summary, or step 7 applies._
6. **Open or update a PR** on branch `blume/sync-docs-<date>` with a summary of what drifted and the fixes. Label it **`docs`** so merge deploys the site ([`docs-governance/LIFECYCLE.md`](../docs-governance/LIFECYCLE.md) § README surfaces). Follow commit/PR conventions; never `--no-verify` ([`no-bypass-hooks`](../../rules/no-bypass-hooks.md)). _Done: PR open with `docs` label and drift summary, or step 7 applies._
7. **Clean no-op** — if nothing drifted, report the PRs checked and surfaces audited; **do not open a PR.** _Done: report lists every PR checked and every surface audited._

## Boundaries
Expand Down
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ git checkout -b your-branch-name
git push -u origin your-branch-name
```

Then open a PR on GitHub into **`main`**.
Then open a PR on GitHub into **`main`**. PRs that change the public docs site (`apps/docs/**`) should carry the **`docs`** label — merge deploys https://stainless-code.com/layers (see [`.github/workflows/deploy-docs.yml`](workflows/deploy-docs.yml)).

### Git hooks

Expand Down
1 change: 1 addition & 0 deletions apps/docs/components/blume/Footer.astro
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const groups: { label: string; links: { href: string; label: string; external?:
{ href: contentHref("/adapters/angular"), label: "Angular" },
{ href: contentHref("/adapters/vue"), label: "Vue" },
{ href: contentHref("/adapters/lit"), label: "Lit" },
{ href: contentHref("/adapters/alpine"), label: "Alpine" },
{ href: contentHref("/adapters/svelte/runes"), label: "Svelte" },
],
},
Expand Down
Loading