Split API docs into per-resource sections under docs/api/#2793
Merged
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the API documentation by splitting the large monolithic docs/API.md file into a modular structure under docs/api/, creating a more maintainable and navigable documentation set.
Changes:
- Deleted the large 1,779-line
docs/API.mdfile - Created
docs/api/README.mdas the main entry point with cross-links to all resource documentation - Created 15 individual resource documentation files under
docs/api/sections/for each API resource
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/api/README.md | New main API documentation entry point with authentication guide links, caching, errors, pagination, and complete endpoint index |
| docs/api/sections/authentication.md | Complete authentication guide including personal access tokens and magic link authentication |
| docs/api/sections/identity.md | Identity endpoint documentation |
| docs/api/sections/account.md | Account settings and configuration endpoints |
| docs/api/sections/boards.md | Board management endpoints (contains JSON syntax error) |
| docs/api/sections/columns.md | Column/workflow stage endpoints |
| docs/api/sections/cards.md | Card/task management endpoints |
| docs/api/sections/pins.md | Card pinning endpoints |
| docs/api/sections/steps.md | Step/checklist item endpoints |
| docs/api/sections/comments.md | Comment endpoints with rich text support |
| docs/api/sections/reactions.md | Reaction/boost endpoints for cards and comments |
| docs/api/sections/tags.md | Tag management endpoints |
| docs/api/sections/users.md | User management endpoints |
| docs/api/sections/notifications.md | Notification endpoints |
| docs/api/sections/webhooks.md | Webhook management endpoints |
| docs/api/sections/rich_text.md | Rich text format guide and file upload flow |
| docs/API.md | Deleted original monolithic documentation file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…d Rich Text to endpoint index
flavorjones
approved these changes
Apr 6, 2026
flavorjones
left a comment
flavorjones
left a comment
Member
There was a problem hiding this comment.
oh, this is sorely needed!
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
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.
The single
docs/API.mdwas growing large and more endpoints are on the way. Split it into adocs/api/directory with aREADME.mdindex and individual section files per resource.Ref: https://3.basecamp.com/2914079/buckets/46292715/todos/9750753261
Structure
docs/api/README.md— entry point covering authentication summary, caching, errors, pagination, list parameters, file uploads, rich text summary, and a linked index of all sectionsdocs/api/sections/authentication.md— full auth guide (personal access tokens, magic links, session management)docs/api/sections/rich_text.md— rich text format and the direct upload flowboards,columns,cards,pins,steps,comments,reactions,tags,users,notifications,webhooks,identity,accountOpened the corresponding SDK maintenance PR here:
This doesn't change SDK generation itself, but it updates
fizzy-sdkto treat the new split API docs layout as a formal upstream input to spec maintenance by:docs/api/README.mdanddocs/api/sections/in provenancespec/README.mdmake sync-statusdocs-aware