Skip to content

docs: add documentation index#3

Merged
leonbreukelman merged 2 commits into
mainfrom
ba/fmc-mcp-proposal-20260612T033134Z
Jun 12, 2026
Merged

docs: add documentation index#3
leonbreukelman merged 2 commits into
mainfrom
ba/fmc-mcp-proposal-20260612T033134Z

Conversation

@leonbreukelman

Copy link
Copy Markdown
Owner

Summary

  • Adds docs/index.md as the canonical documentation entry point.
  • Links only to the existing README.md and leaves future docs topics as plain text to avoid dead links.

Build Arena provenance

  • Selected by Build Arena weighted intake from a fresh, gate-passing Project Model snapshot.
  • Selected finding: doc.index.missing.
  • Patch gate accepted the final proposal for docs/index.md only.
  • Fable reviewed the actual revised patch and approved it: good=true, safe=true, useful=true, required changes=[]

Verification

  • test -e docs/index.md
  • relative link target check (../README.md) ✅
  • uv run --extra dev python -m pytest -q ✅ 19 passed
  • uv run --extra dev ruff check src/ tests/
  • uv run --extra dev mypy src/
  • git diff --cached --check
  • staged secret-shape scan ✅

No canonical checkout edits were made during Build Arena proposal generation; this PR packages the approved worktree proposal.

Copilot AI review requested due to automatic review settings June 12, 2026 04:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a canonical documentation entry point under docs/ to centralize where documentation starts, while avoiding dead links by only linking to existing content.

Changes:

  • Introduces docs/index.md as the documentation landing page.
  • Links to the root README.md for installation/usage details and lists future doc topics as non-links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@leonbreukelman
leonbreukelman merged commit d60155b into main Jun 12, 2026
1 check passed
@leonbreukelman
leonbreukelman deleted the ba/fmc-mcp-proposal-20260612T033134Z branch June 12, 2026 04:24
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.

2 participants