Skip to content

docs: reconcile schema and minibf coverage with code#986

Merged
scarmuega merged 1 commit intomainfrom
docs/sync-with-code
Apr 30, 2026
Merged

docs: reconcile schema and minibf coverage with code#986
scarmuega merged 1 commit intomainfrom
docs/sync-with-code

Conversation

@scarmuega
Copy link
Copy Markdown
Member

@scarmuega scarmuega commented Apr 30, 2026

Summary

  • Adds an update-docs skill (skills/update-docs/SKILL.md) that documents the source-of-truth for each user-facing doc area (config schema, CLI, MiniBF and MiniKupo route lists) and prescribes a workflow for keeping them in sync.
  • Applies the drift fixes the skill surfaced on a first pass:
    • docs/content/apis/minibf.mdx — add /accounts/{stake_address}/withdrawals, /pools/{id}, and /pools/{id}/metadata to the Coverage table (all three are wired up in crates/minibf/src/lib.rs::build_router_with_facade but were missing from the doc).
    • docs/content/configuration/schema.mdx — correct the serve.minikupo example port from [::]:3100 to [::]:1442 (the actual default produced by dolos init, as set in src/bin/dolos/init.rs) in both the example TOML and the serve.minikupo table; add the missing include_minikupo bullet under logging (the field is already in the table).

Test plan

  • Re-extract MiniBF routes (rg '\.route\(' crates/minibf/src/lib.rs) and confirm every path appears in docs/content/apis/minibf.mdx.
  • Re-extract MiniKupo routes from crates/minikupo/src/lib.rs and confirm parity with docs/content/apis/minikupo.mdx.
  • Spot-check RootConfig in crates/core/src/config.rs against the sections in docs/content/configuration/schema.mdx.
  • Render the docs locally if applicable and confirm no broken tables.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Expanded MiniBF API endpoint coverage by documenting three newly supported Blockfrost API routes: stake address withdrawals, general pool information, and pool metadata.
    • Updated configuration documentation with new logging configuration options and revised endpoint configuration examples.
    • Added contributor guide to help maintain documentation alignment with source code changes.

Add `update-docs` skill describing the source-of-truth for each
user-facing doc (config schema, CLI, MiniBF/MiniKupo route lists), and
apply the drift fixes it surfaces:

- minibf.mdx: add `/accounts/{stake_address}/withdrawals`, `/pools/{id}`,
  `/pools/{id}/metadata` rows (present in `build_router_with_facade`).
- schema.mdx: correct `serve.minikupo` example port from 3100 to 1442
  (matching the `init` default), and add the missing `include_minikupo`
  bullet under `logging`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Documentation-only updates to MiniBF and configuration schema with three new API endpoint routes added to the endpoint coverage docs, a configuration example port change, a new logging option documented, and a new contributor guide for maintaining documentation in sync with code.

Changes

Cohort / File(s) Summary
API & Configuration Documentation
docs/content/apis/minibf.mdx, docs/content/configuration/schema.mdx
Adds three newly supported MiniBF endpoints (stake address withdrawals, pool info, pool metadata) to endpoint coverage; updates serve.minikupo listen address example from [::]:3100 to [::]:1442 and documents new include_minikupo logging configuration option.
Documentation Contributor Guide
skills/update-docs/SKILL.md
New contributor guide defining the doc-to-code mapping and workflow for maintaining API endpoint coverage and configuration documentation in sync with authoritative code locations (config schema, CLI commands, router builders).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Three new routes hop into view,
The docs now match what code can do,
With guidance fresh for those who write,
Our burrows of knowledge shine so bright! ✨

🚥 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 accurately and concisely summarizes the main objective of the pull request: reconciling documentation for schema and MiniBF API coverage with their authoritative code sources.
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 docs/sync-with-code

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

@scarmuega scarmuega merged commit 20f90f3 into main Apr 30, 2026
11 of 12 checks passed
@scarmuega scarmuega deleted the docs/sync-with-code branch April 30, 2026 00:47
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