Rewrite the frontend resource-layer docs for the current surface - #15283
Closed
rtibblesbot wants to merge 5 commits into
Closed
rtibblesbot wants to merge 5 commits into
rtibblesbot wants to merge 5 commits into
Conversation
Contributor
Build Artifacts
Smoke test screenshot |
rtibblesbot
force-pushed
the
issue-15071-77a470
branch
3 times, most recently
from
September 14, 2026 19:24
b509257 to
0c13699
Compare
rtibblesbot
marked this pull request as ready for review
September 14, 2026 19:24
rtibblesbot
force-pushed
the
issue-15071-77a470
branch
from
September 14, 2026 19:35
0c13699 to
2955b6a
Compare
One page owns the resource layer: the methods, `request`, the composables, and the decision list for adding an API call. The three pages that each documented part of it are what let the docs drift out of date. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Drops the Models and Collections narrative along with the caching and `force` guidance, which no longer describe the layer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The Advanced Topics examples called four methods that no longer exist; they become one statement of how an action name maps to a URL name. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The example built the loading and error state that `useList` already returns. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The README still showed `fetchModel`; the component moved to `retrieve`. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
rtibblesbot
force-pushed
the
issue-15071-77a470
branch
from
September 14, 2026 19:41
2955b6a to
e196cff
Compare
Member
|
Superseded by #15285. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The frontend docs still taught
Model/Collectionobjects,fetchModel/fetchCollection, and cache-management helpers that the resource layer no longer has. A newResource layerreference page now owns that surface — the methods,request, the reactive composables, and how to add an API call — and the data-flow, URL how-to, composables and sandbox pages keep their own subject and link to it instead of duplicating it.References
Fixes #15071. Suffix-free method names in the examples land with #15233.
Reviewer guidance
uv run --group docs sphinx-build -E -b html docs /tmp/kolibri-docs— succeeds with the same 2 warnings develop already has. The repo'sDocsworkflow is disabled, so nothing on CI builds these pages.grep -rnE 'fetchModel|fetchCollection|saveModel|deleteModel|clearCache' docs/ packages/*/README.md— no hits.Open risk:
ContentNodeProgressResource.fetchTreeandContentNodeResource.fetchBookmarks; both still carry a_v2suffix on develop until Remove the old Resource surface and the _v2 method scaffolding #15233 lands.AI usage
Used Claude Code to draft the pages from
packages/kolibri/apiResource.jsand to check every signature, return shape andfile:linecitation against it. Verified with the Sphinx build and prek.🤖 Generated with Claude Code
@rtibblesbot's comments are generated by an LLM, and should be evaluated accordingly
How was this generated?
🟡 Waiting for feedback
Last updated: 2026-09-14 19:41 UTC