docs: Add an example of custom runtime parameters extending the builder

[marcelomendoncasoares]

Address the pending comment from PR #296.

Summary by CodeRabbit

• Documentation
  • Expanded documentation to include a new method for creating custom runtime parameter groups using a builder extension.
  • Added example code demonstrating the new approach and its integration with built-in parameters.
  • Improved clarity with minor wording adjustments.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for Serverpod's runtime parameters was updated to introduce a third method for creating custom runtime parameter groups. This new approach involves extending the RuntimeParametersBuilder class with custom builder methods, alongside the previously documented methods. Example code and usage scenarios were added and existing text was clarified.

Changes

File(s)	Change Summary
docs/06-concepts/06-database/12-runtime-parameters.md	Expanded documentation to add a third approach for creating custom runtime parameter groups using builder extensions; included example code, usage demonstration, and minor wording improvements.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant RuntimeParametersBuilder
    participant CustomRuntimeParameters

    Developer->>RuntimeParametersBuilder: call extension method (e.g., classCustomParameters)
    RuntimeParametersBuilder-->>CustomRuntimeParameters: instantiate with custom params
    CustomRuntimeParameters-->>Developer: return custom runtime parameters instance

Loading

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/06-concepts/06-database/12-runtime-parameters.md (1)

156-158: Clarify import for CustomRuntimeParameters.

The extension snippet only imports package:serverpod/database.dart, but to use CustomRuntimeParameters you must also import (or define in the same file) the module where CustomRuntimeParameters is declared.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64b95a9 and 1fd662b.

📒 Files selected for processing (1)

• docs/06-concepts/06-database/12-runtime-parameters.md (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test build

🔇 Additional comments (4)

docs/06-concepts/06-database/12-runtime-parameters.md (4)

104-104: Updated phrasing is clear and inclusive of the new method.

Changing “one of two ways” to “the following ways” accurately reflects the addition of a third approach.

---

129-129: Heading description is concise and accurate.

The instruction to extend RuntimeParameters with an overridden options getter is clear.

---

151-151: Sub-heading aligns with existing structure.

Using “Extending the builder class with custom methods” matches the style of the other examples.

---

153-153: Introduction sentence succinctly explains the new example.

Readers will understand they’re adding extension methods to the builder.

[SandPod]

LGTM! 👍