docs: move audit-channel how-to from recipes to a maintainer ops runbook - #105
Merged
Conversation
The out-of-band audit channel is maintainer-only (it runs through the `ctxctl` binary, which ships to no end user), so its how-to does not belong among the user-facing recipes. Relocate it to the operations / contributor surface and make contributing.md the clear entry point. - Move docs/recipes/audit-channel.md -> docs/operations/runbooks/audit-channel.md (git rename), beside the other maintainer runbooks (codebase-audit, docs-semantic-audit); fix its now-deeper relative links (banner image, context-health). - contributing.md: the ctxctl section now states it covers only build/install and points to the runbook for the full workflow (a clear directive, not a skippable aside). - recipes/index.md: replace the full entry with a short pointer to the runbook. Keeps an inbound redirect, removes it from user recipes, and clears the name overlap with recipes/system-hooks-audit.md. - zensical.toml + operations/index.md: register the runbook under Operations -> Runbooks. - specs/ctxctl-bootstrap.md: update the doc's path reference. - Regenerate the docs site (site/**, feed); no orphaned recipe page. Verification: `make lint` 0 issues (both modules), `make test` green (both modules); all changed doc links resolve. Spec: specs/ctxctl-bootstrap.md Signed-off-by: Jose Alekhinne <jose@ctx.ist>
josealekhine
added a commit
that referenced
this pull request
Jul 7, 2026
docs: move audit-channel how-to from recipes to a maintainer ops runbook
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
1 participant
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.
The out-of-band audit channel is maintainer-only (it runs through the
ctxctlbinary, which ships to no end user), so its how-to does not belong among the user-facing recipes. Relocate it to the operations / contributor surface and make contributing.md the clear entry point.Verification:
make lint0 issues (both modules),make testgreen (both modules); all changed doc links resolve.Spec: specs/ctxctl-bootstrap.md