docs: consolidate AI-discoverability docs under docs/ai-discoverability/#29
Merged
Merged
Conversation
The eleven docs that explain why and how the AI-discoverability framework was designed now live together under one subdirectory. A future maintainer (human or agent) can replay the design decisions from one curated set before changing anything. Moves (all via git mv — git tracks as renames, history preserved): * AI-discoverability-guide.md * AI-discoverability-plan.md * current-state-inventory-priority.md * phase0-plan.md, phase0-status.md * phase1-plan.md, phase1-evidence.md * phase3-plan.md, phase3-evidence.md * phase4-plan.md, phase4-evidence.md Internal cross-refs between these docs are sibling-relative, so they survive the group move unchanged. The four external refs from docs/recipes/README.md got their paths bumped from `../<file>.md` to `../ai-discoverability/<file>.md`. New docs/ai-discoverability/README.md serves as the entry-point index: "read this first" pointers (guide → plan → inventory), a phase table with plan + evidence side-by-side, and an explicit "what this directory is NOT" so a future agent doesn't add a recipe or a generated artifact here. docs/ now contains three subdirs only — ai-discoverability/ (this move), recipes/ (Phase-3 mechanically-runnable artifacts), history/ (archived prose like the m-tools rehosted docs). All four meta-repo gates stay green after the move: * make check-docs-prose — clean (md-only under docs/) * make recipes-check — 4/4 clean (recipes-side cross-refs updated) * make handshake — 8/8 steps green * make validate-catalog — OK * pytest profile/build/ — 51/51 Two known external-URL ref sets need a follow-up pass (not in this PR — out-of-org change): * m-dev-tools-mcp repo (AGENTS.md, README.md, examples/) carries hard-coded URLs like https://github.com/m-dev-tools/.github/blob/main/docs/phase4-plan.md — those'll surface GitHub's "moved" hint after this lands but should be bumped in their own MCP-side PR. * ~/claude/memory/ entries reference local paths under ~/m-dev-tools/.github/docs/ — bumping those is a memory-only cleanup.
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
The eleven docs that explain why and how the AI-discoverability framework was designed now live together under one subdirectory. A future maintainer (human or agent) can replay the design decisions from one curated set before changing anything.
Moves (all via
git mv— git tracks as renames, history preserved)AI-discoverability-guide.mdAI-discoverability-plan.mdcurrent-state-inventory-priority.mdphase0-plan.md,phase0-status.mdphase1-plan.md,phase1-evidence.mdphase3-plan.md,phase3-evidence.mdphase4-plan.md,phase4-evidence.mdInternal cross-refs between these docs are sibling-relative, so they survive the group move unchanged. The four external refs from
docs/recipes/README.mdgot bumped from../<file>.md→../ai-discoverability/<file>.md.New index
docs/ai-discoverability/README.mdis the entry point:docs/ layout after this PR
Gates green locally
make check-docs-prose— clean (md-only under docs/)make recipes-check— 4/4 clean (cross-refs updated)make handshake— 8/8 steps greenmake validate-catalog— OKpytest profile/build/— 51/51Known external-URL refs (out-of-scope follow-up)
AGENTS.md,README.md,examples/) carries hard-coded URLs likehttps://github.com/m-dev-tools/.github/blob/main/docs/phase4-plan.md. Those'll surface GitHub's "file moved" hint after this lands but should be bumped in their own MCP-side PR.~/claude/memory/entries reference local paths under~/m-dev-tools/.github/docs/. Memory-only cleanup; no public surface impact.Test plan
git mvpreserves rename history (100% match per git's detector)