doc: add list workspace wiki pages API doc#257
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdded documentation for a new API endpoint to list workspace pages. The change includes a sidebar navigation update to point to the new reference page and comprehensive endpoint documentation detailing parameters, authentication requirements, request examples, and response structure. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/api-reference/page/list-workspace-pages.md`:
- Line 21: Change the three headings currently written as H3 ("### Path
Parameters" and the other two headings at the same locations) to H2 ("## …") so
they follow the H1 in the document and satisfy MD001; specifically update the
headings labeled "Path Parameters" and the other headings at the same spots
(previously prefixed with ###) to use ## instead.
🪄 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: 4a80e8a6-dad0-41a8-96e1-44d274d4283f
📒 Files selected for processing (2)
docs/.vitepress/config.mtsdocs/api-reference/page/list-workspace-pages.md
|
|
||
| <div class="params-section"> | ||
|
|
||
| ### Path Parameters |
There was a problem hiding this comment.
Fix heading-level jump to satisfy markdown lint (MD001).
After the H1 on Line 7, Lines 21/36/75 should be H2, not H3. This can fail docs lint checks.
💡 Proposed fix
-### Path Parameters
+## Path Parameters
...
-### Query Parameters
+## Query Parameters
...
-### Scopes
+## ScopesAlso applies to: 36-36, 75-75
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 21-21: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/api-reference/page/list-workspace-pages.md` at line 21, Change the three
headings currently written as H3 ("### Path Parameters" and the other two
headings at the same locations) to H2 ("## …") so they follow the H1 in the
document and satisfy MD001; specifically update the headings labeled "Path
Parameters" and the other headings at the same spots (previously prefixed with
###) to use ## instead.
Description
Type of Change
Screenshots and Media (if applicable)
Screen.Recording.2026-04-08.at.4.28.50.PM.mov
Test Scenarios
References
Summary by CodeRabbit