Skip to content

ROADMAP: add doc-consolidation side issues (#538, #539, #540)#541

Merged
aallan merged 2 commits into
mainfrom
add-doc-consolidation-issues-to-roadmap
Apr 27, 2026
Merged

ROADMAP: add doc-consolidation side issues (#538, #539, #540)#541
aallan merged 2 commits into
mainfrom
add-doc-consolidation-issues-to-roadmap

Conversation

@aallan

@aallan aallan commented Apr 27, 2026

Copy link
Copy Markdown
Owner

Summary

Adds three doc-consolidation side issues filed during PR #536's review cycle to the ROADMAP, so they're discoverable in the rolling project view rather than only on the issue tracker.

The three were filed when evaluating a documentation-infrastructure consolidation brief against the project's actual pain points. Most of the brief's six phases were either out of scope for #528 (homepage numbers) or speculative — extracted only the elements proportionate to recurring pain:

Issue Phase placement Why there
#538 — inline HTML-comment fence annotations Continuous > CI tooling Removes fix_allowlists.py (recurring source of silent-duplicate-key bugs and per-PR line-shift overhead)
#539vera builtins/effects/errors --json Phase 3a — Agent integration Makes Vera the source of truth for "164 built-in functions" instead of CLAUDE.md being canon. Same agent-ergonomics shape as the existing --json diagnostics
#540 — lychee + markdownlint MD051 Continuous > CI tooling Catches silent broken-anchor class across the 30+ markdown files

Test plan

  • ROADMAP renders correctly
  • Doc validators clean (no count drift)

Out of scope (explicitly NOT proposing)

The full brief proposed Cog-weaving facts into prose (Phase 2), roadmap.yml schema (Phase 4a), and a vera doctor orchestrator (Phase 6). All three were evaluated and consciously skipped — see #528 comment for the reasoning. This PR captures only what's proportionate to actual recurring pain.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Roadmap updated with planned CLI compiler-introspection enhancements to expose registries as structured JSON for editor/LSP/agent use, including per-item "since" metadata and prioritised output ordering.
    • Roadmap updated with documentation-tooling improvements: migration to inline allowlist annotations and strengthened cross-file anchor validation for more reliable docs and checks.

These three issues were filed during the #528 doc-consolidation brief
evaluation -- elements of the brief proportionate to actual project
pain, scoped separately from #528's narrower 'gate homepage numbers'
core. Adding them to the ROADMAP so they're discoverable, not just
issue-tracker-only.

  #538 (inline HTML-comment fence annotations replacing line-numbered
       allowlists) -> Continuous > CI tooling. Removes fix_allowlists.py
       which has been a recurring source of silent-duplicate-key bugs
       and per-PR line-shift overhead.

  #539 (vera builtins/effects/errors --json introspection subcommands)
       -> Phase 3a Agent integration. Makes Vera the source of truth
       for '164 built-in functions' instead of CLAUDE.md being canon.
       Same agent-ergonomics shape as the existing --json diagnostics.

  #540 (lychee + markdownlint MD051 cross-doc anchor validation)
       -> Continuous > CI tooling. Catches the silent-broken-link
       class across the 30+ markdown files that link each other's
       section anchors.

Phase placement reflects natural fit: agent-facing compiler features
in 3a; CI/tooling hygiene in Continuous.

Co-Authored-By: Claude <noreply@anthropic.invalid>
@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d1372b1f-7431-4702-9965-0ef74eee68b1

📥 Commits

Reviewing files that changed from the base of the PR and between 4a430fa and 16a2d7a.

📒 Files selected for processing (1)
  • ROADMAP.md

📝 Walkthrough

Walkthrough

ROADMAP.md updated to document planned work on a CLI compiler-introspection wrapper exposing builtins, effects, and error-code registries via structured JSON output with per-item since metadata, and documentation/tooling hardening: migrate allowlists to inline HTML-comment fences and add lychee + markdownlint-cli2 MD051 anchor validation.

Changes

Cohort / File(s) Summary
Roadmap Updates
ROADMAP.md
Adds planned CLI compiler-introspection wrappers (JSON output for builtins/effects/error-codes with since metadata) and documents migration of documentation allowlists to inline HTML-comment fences; introduces anchor cross-validation using lychee and markdownlint-cli2 MD051.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

Possibly related PRs

Suggested labels

docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately reflects the core change: adding three documentation-consolidation side issues to the ROADMAP, with precise issue references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-doc-consolidation-issues-to-roadmap

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Apr 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.02%. Comparing base (9cae151) to head (16a2d7a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #541   +/-   ##
=======================================
  Coverage   91.02%   91.02%           
=======================================
  Files          58       58           
  Lines       22033    22033           
  Branches      259      259           
=======================================
  Hits        20055    20055           
  Misses       1971     1971           
  Partials        7        7           
Flag Coverage Δ
javascript 56.83% <ø> (ø)
python 94.97% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aallan aallan merged commit 40396b6 into main Apr 27, 2026
19 checks passed
@aallan aallan deleted the add-doc-consolidation-issues-to-roadmap branch April 27, 2026 13:14
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