docs: Add documentation for client-side endpoint inheritance

[marcelomendoncasoares]

Documentation for the feature introduced at serverpod/serverpod#4023.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[SandPod]

Changes looks good!

Is it perhaps time to split this page soon? It feels like it is hard to understand when to stop reading this page as a beginner. Perhaps we should have at least two subpages for endpoints? Or a proper endpoints reference section that is separate from working-with-endpoints?

[marcelomendoncasoares]

The page is indeed getting very long, and with lots of advanced use cases that make understanding harder for newcomers.

@coderabbitai Please create an issue to split the working-with-endpoints page as suggested by @SandPod. This way we don't bundle a refactor here.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get PR details and comments to understand the context
gh pr view 333 --repo serverpod/serverpod_docs --json title,body,url,comments --jq '.comments[] | select(.author.login == "SandPod") | {author: .author.login, body: .body, url: .url}'

Length of output: 0

---

🏁 Script executed:

#!/bin/bash
# Get all comments to understand the full context
gh pr view 333 --repo serverpod/serverpod_docs --json title,body,url,comments --jq '{title: .title, url: .url, comments: [.comments[] | {author: .author.login, body: .body}]}'

Length of output: 3590

---

🏁 Script executed:

#!/bin/bash
# Get review comments to find SandPod's suggestion
gh api "repos/serverpod/serverpod_docs/pulls/333/comments" --jq '.[] | select(.user.login == "SandPod") | {author: .user.login, body: .body, url: .html_url}'

Length of output: 274

---

🏁 Script executed:

#!/bin/bash
# If SandPod's comment is not found, get all review comments for context
gh api "repos/serverpod/serverpod_docs/pulls/333/comments" --jq '.[] | {author: .user.login, body: .body, path: .path}'

Length of output: 1035

---

🏁 Script executed:

#!/bin/bash
# Get all review comments with more context
gh api "repos/serverpod/serverpod_docs/pulls/333/comments" --jq '.[] | {author: .user.login, body: .body, created_at: .created_at, url: .html_url} | select(.body | contains("split") or contains("long") or contains("refactor") or contains("page"))'

Length of output: 0

---

🏁 Script executed:

#!/bin/bash
# Check issue comments for any discussion threads
gh api "repos/serverpod/serverpod_docs/issues/333/comments" --jq '.[] | {author: .user.login, body: .body, url: .html_url}'

Length of output: 3618

---

🏁 Script executed:

#!/bin/bash
# Create GitHub issue to split the working-with-endpoints page
gh issue create \
  --repo serverpod/serverpod_docs \
  --title "Split working-with-endpoints page into multiple pages" \
  --body "## Description

The \`working-with-endpoints\` page (docs/06-concepts/01-working-with-endpoints.md) is getting very long and includes many advanced use cases that make understanding harder for newcomers.

## Proposal

Split the page into multiple focused pages to improve readability and learning experience:
- Keep basic endpoint concepts on the main page
- Move advanced use cases to separate pages

## Context

This issue was created as a follow-up to PR serverpod/serverpod_docs#333, which adds documentation for client-side endpoint inheritance. To avoid bundling refactoring work with the feature documentation, this split should be done in a separate PR.

## References

- PR: https://github.com/serverpod/serverpod_docs/pull/333
- Comment: https://github.com/serverpod/serverpod_docs/pull/333#issuecomment-3381407441
- Suggested by: @SandPod
- Requested by: @marcelomendoncasoares" \
  --assignee marcelomendoncasoares

Length of output: 54

---

@marcelomendoncasoares I've created issue serverpod/serverpod#4047 to track the splitting of the working-with-endpoints page. The issue includes references to this PR and your comment, and has been assigned to you.

Issue link: serverpod/serverpod#4047

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@marcelomendoncasoares I've created issue serverpod/serverpod#4047 to track the splitting of the working-with-endpoints page. The issue includes:

• References to this PR and the discussion
• Assignment to you as requested
• Context about the page being too long with advanced use cases

You can view the issue here: serverpod/serverpod#4047

This allows you to proceed with the current PR without bundling the refactoring work. 🐰