docs: Splitting endpoint page into three use cases#464
Open
docs: Splitting endpoint page into three use cases#464
Conversation
d60000d to
7411769
Compare
7411769 to
78b4f1b
Compare
There was a problem hiding this comment.
Pull request overview
Splits the “Working with endpoints” documentation into a folder with three focused pages to reduce information overload for new users, while preserving existing advanced content as separate use cases.
Changes:
- Introduces a new “Working with endpoints” category with a linked landing doc.
- Moves the core endpoint documentation into a dedicated page with a stable slug (
/concepts/working-with-endpoints). - Extracts advanced sections into separate pages for endpoint inheritance and middleware.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/06-concepts/01-working-with-endpoints/category.json | Defines the new sidebar category and links the category click to the landing doc. |
| docs/06-concepts/01-working-with-endpoints/01-working-with-endpoints.md | New core “Working with endpoints” page (basics + clarity edits). |
| docs/06-concepts/01-working-with-endpoints/02-endpoint-inheritance.md | Refactors the old combined page into a focused “Endpoint inheritance” doc. |
| docs/06-concepts/01-working-with-endpoints/03-middleware.md | New standalone “Middleware” doc extracted from the old combined page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
78b4f1b to
3bfa10a
Compare
Zfinix
approved these changes
Apr 15, 2026
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.
Problem
The endpoints page has grown quite large over time, covering advanced use cases that might give new users "information overload".
Solution
Divide the file into three use cases:
Change in menu structure
The files are placed in a new folder, and the core page ("Working with endpoints") loads when the "Working with endpoints" menu category is clicked.
Clarity edits
Also made some clarity edits to the core page in a separate commit.
Fixes serverpod/serverpod#4047.