Skip to content

docs: Splitting endpoint page into three use cases#464

Open
Swiftaxe wants to merge 2 commits intomainfrom
feat/improve-endpoints
Open

docs: Splitting endpoint page into three use cases#464
Swiftaxe wants to merge 2 commits intomainfrom
feat/improve-endpoints

Conversation

@Swiftaxe
Copy link
Copy Markdown
Contributor

@Swiftaxe Swiftaxe commented Apr 13, 2026

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:

  1. Working with endpoints (core page, the basics)
  2. Endpoint inheritance
  3. Middleware

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.

image

Clarity edits

Also made some clarity edits to the core page in a separate commit.

Fixes serverpod/serverpod#4047.

@Swiftaxe Swiftaxe changed the title Splitting endpoint page into three use cases docs: Splitting endpoint page into three use cases Apr 13, 2026
@Swiftaxe Swiftaxe force-pushed the feat/improve-endpoints branch from d60000d to 7411769 Compare April 13, 2026 09:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/06-concepts/01-working-with-endpoints/03-middleware.md Outdated
@Swiftaxe Swiftaxe force-pushed the feat/improve-endpoints branch from 78b4f1b to 3bfa10a Compare April 14, 2026 05:02
@Swiftaxe Swiftaxe requested review from Zfinix and vlidholt April 14, 2026 05:29
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.

Split working-with-endpoints page into multiple pages

3 participants