Skip to content

docs: define greppability conventions for new seams - #469

Draft
remember993 wants to merge 1 commit into
inclusionAI:mainfrom
remember993:codex/greppability-conventions
Draft

docs: define greppability conventions for new seams#469
remember993 wants to merge 1 commit into
inclusionAI:mainfrom
remember993:codex/greppability-conventions

Conversation

@remember993

Copy link
Copy Markdown

Summary

Adds repository-wide greppability conventions for future protocol seams, with concrete rollout-engine and weight-sync examples.

What changed

  • Defines capability-stem naming patterns for protocols, configs, contexts, and registry specs.
  • Requires descriptive resolver names and a searchable user-key -> registration -> spec/adapter -> resolver -> consumer path.
  • Documents the existing algorithm and model-adapter registries as authoritative, without renaming APIs or changing runtime behavior.

Closes #57

Validation

  • git diff --check
  • Strict Sphinx HTML build with sphinx-build -E -a -W --keep-going -b html docs <temp-dir> using the documented Shibuya theme
  • No GPU, model download, or runtime tests required; documentation-only change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define greppability conventions for new seams

1 participant