Review exploring-the-docs and add doc consistency checks #112

Merged

eblume merged 4 commits from doc/exploring-the-docs-review into main 2026-02-05 21:12:07 -08:00

Conversation 0 Commits 4 Files changed 13 +375 -23

eblume commented 2026-02-05 21:06:40 -08:00

Owner

Copy link

Summary

• Reviewed and cleaned up exploring-the-docs tutorial: simplified wiki-links, fixed broken replication/ reference, added Related section, corrected zk-docs flags to match CLAUDE.md
• Added orphan detection to doc-links (finds docs not linked from any other doc)
• Added new doc tooling: doc-index (checks category index coverage), doc-stale (staleness report), doc-tags (tag inventory)
• Added doc-index as a pre-commit hook
• Updated use-pypi-proxy to document env-var-based proxy toggle for pip/uv
• Updated ai-assistance-guide with new doc task descriptions

Test plan

• Run mise run doc-links — passes
• Run mise run doc-index — passes
• Run mise run doc-stale — informational output
• Run mise run doc-tags — informational output
• Pre-commit hooks pass

🤖 Generated with Claude Code

## Summary - Reviewed and cleaned up exploring-the-docs tutorial: simplified wiki-links, fixed broken replication/ reference, added Related section, corrected zk-docs flags to match CLAUDE.md - Added orphan detection to doc-links (finds docs not linked from any other doc) - Added new doc tooling: `doc-index` (checks category index coverage), `doc-stale` (staleness report), `doc-tags` (tag inventory) - Added `doc-index` as a pre-commit hook - Updated use-pypi-proxy to document env-var-based proxy toggle for pip/uv - Updated ai-assistance-guide with new doc task descriptions ## Test plan - [ ] Run `mise run doc-links` — passes - [ ] Run `mise run doc-index` — passes - [ ] Run `mise run doc-stale` — informational output - [ ] Run `mise run doc-tags` — informational output - [ ] Pre-commit hooks pass 🤖 Generated with [Claude Code](https://claude.com/claude-code)

eblume added 2 commits 2026-02-05 21:06:41 -08:00

Review exploring-the-docs: fix links, add Related section ... e5cc00f1cc

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add doc consistency checks and update pypi proxy docs ... a3dec7f6e2

Add orphan detection to doc-links, and three new doc tasks: doc-index
(category index coverage), doc-stale (staleness report), doc-tags (tag
inventory). Register doc-index as a pre-commit hook. Update
use-pypi-proxy to document env-var-based proxy toggle.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

eblume added 1 commit 2026-02-05 21:10:29 -08:00

Add pre-commit to mise.toml project tools ... 12eab01c55

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

eblume added 1 commit 2026-02-05 21:11:38 -08:00

Split changelog fragment by type (doc, feature, infra) ... e6da019174

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

eblume merged commit 060c7a24e3 into main 2026-02-05 21:12:07 -08:00

eblume referenced this pull request from a commit 2026-02-05 21:12:09 -08:00

Review exploring-the-docs and add doc consistency checks (#112)

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

eblume/blumeops!112

No description provided.