docs: relocate Supabase Knowledge Search runbook from wiki; revise ADR 0006#421
Merged
Conversation
…R 0006 Maintainer/operational runbooks should not be published on the public wiki. Adds runbooks/supabase-knowledge-search.md and revises ADR 0006 so community/ holds community content only and maintainer ops docs live in z-shell/.github/runbooks/.
Contributor
There was a problem hiding this comment.
Pull request overview
Moves maintainer-only operational guidance for the Supabase-backed Knowledge Search out of the public wiki and updates ADR 0006 to reflect that maintainer/operational runbooks belong in z-shell/.github/runbooks/.
Changes:
- Added an org-repo runbook documenting how to index and query the Supabase Knowledge Search.
- Updated the instruction-update checklist to route maintainer/operational runbooks to this repo instead of the wiki.
- Revised ADR 0006 to redefine wiki content-root boundaries and explicitly exclude operational runbooks from the public wiki.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
runbooks/supabase-knowledge-search.md |
New operational runbook for Knowledge Search indexing/querying and access control notes. |
runbooks/instruction-update.md |
Updates the wiki checklist to reflect the new boundary: ops runbooks live in this repo’s runbooks/. |
decisions/0006-wiki-content-root-boundaries.md |
Revises the ADR decision and consequences to exclude maintainer/ops content from the public wiki. |
Agent-Logs-Url: https://github.com/z-shell/.github/sessions/9210f5f4-27ca-4a82-b137-a93f11a5ad9c Co-authored-by: ss-o <59910950+ss-o@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #420. Maintainer/operational documentation should not be published on the public wiki — it leaks ops surface (secret names, infra topology) and is irrelevant to wiki readers.
runbooks/supabase-knowledge-search.md— the operational guide (secrets, indexing, querying, access control), moved out of the wiki.community/now holds community content only; maintainer/operational runbooks live inz-shell/.github/runbooks/, not the wiki. (ADR remainsPROPOSED.)Paired with the wiki-side change (removes
community/10_maintainers/and updates the boundary instructions) onz-shell/wikiPR #740.