docs: reconcile schema and minibf coverage with code#986
Conversation
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>
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughDocumentation-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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
Summary
update-docsskill (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.docs/content/apis/minibf.mdx— add/accounts/{stake_address}/withdrawals,/pools/{id}, and/pools/{id}/metadatato the Coverage table (all three are wired up incrates/minibf/src/lib.rs::build_router_with_facadebut were missing from the doc).docs/content/configuration/schema.mdx— correct theserve.minikupoexample port from[::]:3100to[::]:1442(the actual default produced bydolos init, as set insrc/bin/dolos/init.rs) in both the example TOML and theserve.minikupotable; add the missinginclude_minikupobullet underlogging(the field is already in the table).Test plan
rg '\.route\(' crates/minibf/src/lib.rs) and confirm every path appears indocs/content/apis/minibf.mdx.crates/minikupo/src/lib.rsand confirm parity withdocs/content/apis/minikupo.mdx.RootConfigincrates/core/src/config.rsagainst the sections indocs/content/configuration/schema.mdx.🤖 Generated with Claude Code
Summary by CodeRabbit