Skip to content

docs: consolidate AI-discoverability docs under docs/ai-discoverability/#29

Merged
rafael5 merged 1 commit into
mainfrom
chore/ai-discoverability-docs-layout
May 11, 2026
Merged

docs: consolidate AI-discoverability docs under docs/ai-discoverability/#29
rafael5 merged 1 commit into
mainfrom
chore/ai-discoverability-docs-layout

Conversation

@rafael5
Copy link
Copy Markdown
Contributor

@rafael5 rafael5 commented May 11, 2026

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.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 bumped from ../<file>.md../ai-discoverability/<file>.md.

New index

docs/ai-discoverability/README.md is the entry point:

  • "Read this first" pointers (guide → plan → inventory)
  • A phase table with plan + evidence side-by-side
  • Explicit "what this directory is NOT" so a future agent doesn't add a recipe or a generated artifact here

docs/ layout after this PR

docs/
├── ai-discoverability/       # ← this PR's home
│   ├── README.md
│   ├── AI-discoverability-guide.md
│   ├── AI-discoverability-plan.md
│   ├── current-state-inventory-priority.md
│   ├── phase{0,1,3,4}-plan.md
│   ├── phase{0}-status.md
│   └── phase{1,3,4}-evidence.md
├── recipes/                  # Phase-3 mechanically-runnable artifacts
└── history/                  # archived prose (m-tools rehosted docs, ...)

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 green
  • make validate-catalog — OK
  • pytest profile/build/ — 51/51

Known external-URL refs (out-of-scope follow-up)

  • 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 "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

  • All five local gates green
  • git mv preserves rename history (100% match per git's detector)
  • CI green

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.
@rafael5 rafael5 merged commit 91c2d00 into main May 11, 2026
2 checks passed
@rafael5 rafael5 deleted the chore/ai-discoverability-docs-layout branch May 11, 2026 13:02
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.

1 participant