Add additional api menu entries - #255
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAPI documentation navigation adds an ChangesAPI Reference Navigation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Adds new API reference navigation entries so the documentation site exposes the newly documented Budgets and Accountability API operations (as referenced in the linked decidim/decidim PRs).
Changes:
- Add Budgets API reference menu group with Budget and Project CRUD operation links.
- Add Accountability API reference menu group with Result and Milestone CRUD operation links.
Comments suppressed due to low confidence (1)
docs/en/modules/ROOT/nav.adoc:270
- The action links under Accountability are ordered Create → Delete → Update. For consistency with other action lists in this same section, consider reordering to Create → Update → Delete.
****** xref:develop:api/reference/components/accountability/create.adoc[Create Result]
****** xref:develop:api/reference/components/accountability/delete.adoc[Delete Result]
****** xref:develop:api/reference/components/accountability/update.adoc[Update Result]
****** xref:develop:api/reference/components/accountability/milestone/create.adoc[Create Milestone]
****** xref:develop:api/reference/components/accountability/milestone/update.adoc[Update Milestone]
****** xref:develop:api/reference/components/accountability/milestone/delete.adoc[Delete Milestone]
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/en/modules/ROOT/nav.adoc`:
- Around line 257-270: The new xrefs in docs/en/modules/ROOT/nav.adoc reference
non-existent pages (e.g.,
develop:api/reference/components/accountability/create.adoc,
develop:api/reference/components/accountability/milestone/create.adoc,
develop:api/reference/components/budgets/create.adoc,
develop:api/reference/components/budgets/projects/create.adoc); either change
those xref targets to the actual existing docs under admin (for example point to
admin pages like
docs/en/modules/admin/pages/components/accountability/results.adoc or
docs/en/modules/admin/pages/components/budgets/projects.adoc) or add the missing
develop:api/reference/... .adoc files so the xrefs resolve; update the lines
that list the xrefs in docs/en/modules/ROOT/nav.adoc to use the correct target
strings or ensure the matching files are created with the expected names.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7855dd46-52ca-4f82-93ac-97841eea417e
📒 Files selected for processing (1)
docs/en/modules/ROOT/nav.adoc
andreslucena
left a comment
There was a problem hiding this comment.
Just one missing error and we're done
Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>
This PR adds the docs links for the work done in: