Split API docs reference for #[builder] into multiple pages

[Veetaha]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new plugin for handling abbreviations in Markdown documentation.
  • Enhanced sidebar navigation for improved user experience.
  • Added new attributes to the builder API, including #[builder(default)], #[builder(skip)], and #[builder(start_fn)].
  • Added support for #[derive(Builder)] syntax for structs, streamlining builder creation.

• Documentation Updates

  • Comprehensive updates to the documentation for the bon crate, including detailed explanations and examples for new features and attributes.
  • Restructured guides and references to improve clarity and usability.

• Bug Fixes

  • Fixed various links and navigation issues within the documentation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several enhancements to the VitePress configuration and documentation of the bon Rust crate. It adds a new vite property with an inject-abbreviations plugin for processing Markdown files, updates the languageAlias in Markdown configuration, and significantly restructures the sidebar navigation. Additionally, it includes extensive updates across various documentation files, detailing new features, breaking changes, and clarifications related to builder patterns and attributes in the bon crate.

Changes

File Path	Change Summary
website/.vitepress/config.mts	Added vite property with inject-abbreviations plugin; updated languageAlias in Markdown configuration; modified sidebar items for better navigation and structure.
website/.vitepress/theme/style.css	Updated comment for .nobr class and retained its functionality.
website/blog/bon-builder-generator-v2-release.md	Documented release of bon crate version 2.0, detailing new features, breaking changes, and documentation updates.
website/blog/bon-builder-v2-1-release.md	Outlined release of version 2.1, highlighting improvements in compilation times and error messaging.
website/blog/bon-builder-v2-2-release.md	Introduced new #[derive(Builder)] syntax for structs, setting minimum supported Rust version to 1.70.0.
website/blog/bon-builder-v2-3-release.md	Updated documentation for version 2.3, detailing new positional arguments in builder functions and clarifying usage of #[builder(start_fn)] and #[builder(finish_fn)].
website/guide/alternatives.md	Enhanced comparison of various builder crates, clarifying features and capabilities.
website/guide/compatibility.md	Clarified compatibility of builder patterns and attributes in Rust, including making required members optional.
website/guide/inspecting.md	Updated references for #[builder(derive(...))] attribute links in documentation.
website/guide/limitations.md	Clarified limitations associated with the bon tool, including intra-doc links and implicit generic lifetimes.
website/guide/optional-members.md	Clarified usage of #[builder(default)] attribute and its interaction with optional members.
website/guide/overview.md	Enhanced explanations and examples for using the #[builder] macro with functions and structs.
website/guide/patterns/conditional-building.md	Improved explanations and examples for managing conditional logic in builder patterns.
website/guide/patterns/into-conversions-in-depth.md	Revised content to clarify the use of impl Into conversions in Rust, detailing when to use and avoid them.
website/reference/builder.md	Expanded documentation on #[builder] attributes, including detailed explanations and examples for various attributes.
website/reference/builder/member/default.md	Introduced documentation for the #[builder(default)] attribute, detailing its functionality and usage.
website/reference/builder/member/finish-fn.md	Documented the finish_fn attribute for builder patterns, detailing its usage and significance.
website/reference/builder/member/into.md	Added documentation for the into feature, specifying how it modifies setter signatures.
website/reference/builder/member/name.md	Documented the name attribute, allowing developers to override default member names in builders.
website/reference/builder/member/skip.md	Introduced documentation for the skip attribute, detailing its functionality in builder patterns.
website/reference/builder/member/start-fn.md	Documented the start_fn attribute, explaining its role in builder patterns.
website/reference/builder/top-level/builder-type.md	Documented the builder_type attribute, detailing how to customize the naming of generated builder structs.
website/reference/builder/top-level/derive.md	Introduced documentation for generating additional derives on builder structs.
website/reference/builder/top-level/finish-fn.md	Documented the finish_fn attribute, explaining how to specify a custom name for the finishing method.
website/reference/builder/top-level/on.md	Introduced the on attribute, allowing specified builder attributes to apply to matching struct members.
website/reference/builder/top-level/start-fn.md	Documented the start_fn attribute, detailing how to customize the starting function in builder patterns.
website/v1/guide/compatibility.md	Updated compatibility documentation for various changes in builder API.
website/v1/guide/limitations.md	Clarified limitations associated with the bon tool, including references to Self and generic lifetimes.
website/v1/guide/optional-members.md	Updated documentation on optional members and their interaction with builder patterns.
website/v1/guide/overview.md	Enhanced overview of the bon crate, adding explanations and examples for builder usage.
website/v1/reference/builder.md	Expanded documentation for the #[builder] attribute, detailing various attributes and their applications.
website/v2/guide/compatibility.md	Updated compatibility documentation for builder syntax changes.
website/v2/guide/limitations.md	Clarified limitations associated with the bon tool, focusing on compile-time errors and requirements.
website/v2/guide/optional-members.md	Updated documentation on optional members and the #[builder(default)] attribute.
website/v2/guide/overview.md	Enhanced overview documentation for the bon crate, focusing on builder usage and conventions.
website/v2/guide/patterns/conditional-building.md	Improved explanations and examples for conditional building patterns in Rust.
website/v2/guide/patterns/into-conversions-in-depth.md	Revised content to clarify the use of impl Into conversions in Rust.
website/v2/reference/builder.md	Enhanced clarity and structure of the #[derive(Builder)] and #[builder] attributes documentation.

Possibly related PRs

• #[builder(crate)] attribute and #[builder(expose_positional_fn)] replacement with #[builder(start_fn)] #153: Introduces the #[builder(crate)] attribute and replaces #[builder(expose_positional_fn)] with #[builder(start_fn)], relating to sidebar configuration and builder attributes.
• #[builder(on(_, transparent))] attribute #155: Implements the #[builder(on(_, transparent))] attribute, relevant to handling builder attributes and documentation.
• #[builder(with = Some / FromIterator::from_iter / <_>::from_iter)] attribute #157: Addresses the #[builder(with = Some / FromIterator::from_iter / <_>::from_iter)] attribute, aligning with improvements to builder functionality and documentation.
• Make overwritable experimental behind a cargo feature #160: Makes the overwritable feature experimental, related to enhancements in builder attributes and configurations.

Suggested reviewers

• anelson

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.