Skip to content

docs: Update Partial Items settings note - #1090

Merged
cassidyjames merged 1 commit into
roostorg:mainfrom
aitorres:aitorres/documentation-update-for-partial-items
Sep 1, 2026
Merged

docs: Update Partial Items settings note#1090
cassidyjames merged 1 commit into
roostorg:mainfrom
aitorres:aitorres/documentation-update-for-partial-items

Conversation

@aitorres

@aitorres aitorres commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Context & Requests for Reviewers

Documentation for Partial Items currently states that it's not possible to configure the API details from the UI and points to issue #378 for additional context.

This note is now outdated as PR #709 introduced a section on the UI to configure the Partial Items API, and #378 is now closed.

PR removes the note from the docs and adds a link to the Settings section where the Partial Items setup screenshot is currently shown.

Tests

Docs build successfully with mdbook build docs

Current docs:
Screenshot 2026-08-31 at 7 51 43 PM

Updated docs:
Screenshot 2026-08-31 at 7 52 28 PM

Checklist

Only check items that apply to this PR; leave the rest unchecked.

  • If you changed anything user-facing (i.e. user interface or APIs):
    Did you update related docs?: Yes, PR is a documentation change.

  • If the change is notable (refer to Keep a Changelog conventions):
    Did you update CHANGELOG.md?

  • If you changed server/models/**/{ContentTypeModel,ActionModel,RuleModel,PolicyModel}.ts:
    Did you update the corresponding history tables and their triggers?

  • If you changed db/src/scripts/** and used CREATE TABLE, ADD COLUMN, or ALTER COLUMN:
    Are as many columns marked NOT NULL as possible? If some columns can sometimes be null depending on other columns, are there CHECK constraints capturing those relationships, and are these also reflected using unions in the associated Kysely types?

  • If you added a new signal in server/services/signalsService/signals/**:
    Did you classify every error case as a permanent error (SignalPermanentError, no retry) or a normal error (retryable)? Any case where the signal can't determine a score should be a SignalPermanentError.

Summary by CodeRabbit

  • Documentation
    • Updated Partial Items API setup instructions to explain that the API URL and required headers can be configured in Coop Settings.
    • Removed outdated limitations and code-management guidance.

Copilot AI lite review requested due to automatic review settings September 1, 2026 02:53
@aitorres
aitorres requested a review from a team as a code owner September 1, 2026 02:53
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 55b9935e-821a-4226-83e8-00d80d89e192

📥 Commits

Reviewing files that changed from the base of the PR and between 05e01ae and 5bba705.

📒 Files selected for processing (1)
  • docs/api/partial-items.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The Partial Items API documentation now explains that the API URL and required headers can be configured under Coop Settings. It removes the previous limitation and code-management instructions.

Changes

Partial Items API documentation

Layer / File(s) Summary
Settings configuration instructions
docs/api/partial-items.md
The documentation directs configuration of the Partial Items API URL and required headers under Coop Settings. It removes outdated code-management guidance.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 5bba7

This localized documentation update removes outdated Partial Items setup guidance and points users to the current Settings instructions; no actionable merge-blocking risk remains.

Suggested reviewers: annebdh

🚥 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 clearly and concisely describes the documentation update for Partial Items settings, which is the main change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Documentation change is consistent with the current Settings docs (anchor exists) and cleanly removes outdated guidance.

Pull request overview

Updates the Partial Items API documentation to reflect that Partial Items configuration is now available in the Coop UI (via Settings), removing an outdated warning that referenced a now-closed issue.

Changes:

  • Removed the “not yet possible to configure from the Coop UI” IMPORTANT note and the link to issue #378.
  • Added a direct link to the Settings → Partial Items section where the endpoint URL/headers can be configured.
File summaries
File Description
docs/api/partial-items.md Replaces the outdated configuration warning with a link to the Settings documentation for configuring Partial Items.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@cassidyjames cassidyjames left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@cassidyjames
cassidyjames merged commit 2fc1ace into roostorg:main Sep 1, 2026
12 checks passed
@aitorres
aitorres deleted the aitorres/documentation-update-for-partial-items branch September 1, 2026 19:17
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.

3 participants