Skip to content

Commit c2448e1

Browse files
committed
docs: move maintainer runbook out of the wiki
The Supabase Knowledge Search maintainer guide is operational documentation (secret names, infra topology, ops CLIs) and does not belong on the public wiki. Relocated to z-shell/.github/runbooks/supabase-knowledge-search.md. Updates the content-root boundaries: community/ holds community content only; maintainer / operational runbooks live in z-shell/.github/runbooks/. Refs ADR 0006.
1 parent 028014f commit c2448e1

5 files changed

Lines changed: 20 additions & 68 deletions

File tree

.github/instructions/agent-docusaurus-writer.instructions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ Invoke the `docusaurus-writer` agent and provide:
3838

3939
Before creating a page, select the root:
4040

41-
- Admin / tooling / operational / infrastructure → `community/`.
4241
- Zi plugin-manager user docs → `docs/`.
42+
- Community content (contributing, handbook, ZUnit) → `community/`.
4343
- Third-party ecosystem (annexes, packages, plugins) → `ecosystem/`.
44+
- Admin / tooling / operational / infrastructure → **not the wiki**; these are
45+
runbooks for `z-shell/.github/runbooks/`.
4446

45-
`docs/` is Zi user docs only — never put maintainer tooling there.
47+
Never put maintainer/operational documentation anywhere in the wiki.

.github/instructions/docs-authoring.instructions.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,17 @@ applyTo: "{docs,community,ecosystem}/**/*.mdx"
99

1010
Choose the content root before writing. The roots are not interchangeable:
1111

12-
| Content type | Root |
13-
| -------------------------------------------------- | ----------------------------------------------- |
14-
| Zi plugin-manager install / commands / usage | `docs/` |
15-
| Contributing, Zsh handbook, plugin standard, ZUnit | `community/` |
16-
| Maintainer / operational / infrastructure guides | `community/` (e.g. `community/10_maintainers/`) |
17-
| Third-party annexes, packages, plugins | `ecosystem/` |
12+
| Content type | Root |
13+
| -------------------------------------------------- | ---------------------------------------------- |
14+
| Zi plugin-manager install / commands / usage | `docs/` |
15+
| Contributing, Zsh handbook, plugin standard, ZUnit | `community/` |
16+
| Maintainer / operational / infrastructure runbooks | **not the wiki**`z-shell/.github/runbooks/` |
17+
| Third-party annexes, packages, plugins | `ecosystem/` |
1818

1919
**Prohibition:** Never place maintainer, operational, or infrastructure
20-
documentation under `docs/`. `docs/` is Zi end-user documentation only.
20+
documentation anywhere in the wiki (neither `docs/` nor `community/`). It leaks
21+
ops surface and belongs in `z-shell/.github/runbooks/`. See ADR
22+
`decisions/0006-wiki-content-root-boundaries.md` in `z-shell/.github`.
2123

2224
## Frontmatter
2325

AGENTS.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ This project follows the organization-wide [Z-Shell Organization Guidelines](htt
2020
- Docusaurus site with three independent docs content roots. Each root has a
2121
fixed scope — do not cross these boundaries:
2222
- `docs/``/docs`**Zi plugin manager user documentation only**
23-
(installation, commands, usage guides). Do NOT place maintainer,
24-
operational, or infrastructure guides here.
23+
(installation, commands, usage guides).
2524
- `community/``/community` — Z-Shell ecosystem community content:
26-
contributing, the Zsh handbook/plugin standard, ZUnit, and **maintainer /
27-
operational tooling guides** (e.g. `community/10_maintainers/`).
25+
contributing, the Zsh handbook/plugin standard, and ZUnit.
2826
- `ecosystem/``/ecosystem` — third-party catalog: annexes, packages, plugins.
27+
- **Maintainer, operational, and infrastructure runbooks do not belong on the
28+
public wiki.** They live in `z-shell/.github/runbooks/` (e.g.
29+
`runbooks/supabase-knowledge-search.md`). Feature implementation code
30+
(Edge Functions, migrations, scripts under `supabase/` and `scripts/`) still
31+
lives here in the wiki repo.
2932
- Each content root uses the shared `sidebars.ts` (autogenerated from directory structure) plus local `_category_.json` files for ordering.
3033
- Site config, plugins, and routing: `docusaurus.config.ts`. See `.github/instructions/docusaurus-config.instructions.md` for config structure, feature flags, and constraints.
3134
- Docusaurus client API (components, hooks, theme imports): `.github/instructions/docusaurus-api.instructions.md` — prefer native Docusaurus components over raw HTML equivalents.

community/10_maintainers/01_supabase_knowledge_search.mdx

Lines changed: 0 additions & 48 deletions
This file was deleted.

community/10_maintainers/_category_.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)