Skip to content

docs: Complete builder API tables and align heading casing - #1778

Merged
HofmeisterAn merged 1 commit into
developfrom
docs/complete-builder-api-tables
Sep 28, 2026
Merged

HofmeisterAn merged 1 commit into
developfrom
docs/complete-builder-api-tables

Conversation

@HofmeisterAn

@HofmeisterAn HofmeisterAn commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

What does this PR do?

-

Why is it important?

-

Related issues

-

Summary by CodeRabbit

  • Documentation
    • Standardized capitalization and title casing across API, module, and example documentation.
    • Clarified builder-method support, including resource reuse, targets, logging, mounts, and connection-string providers.
    • Separated remote-resource copy examples into directory and file tabs.
    • Removed test-project callouts from the Garnet and Valkey usage pages.

@HofmeisterAn
HofmeisterAn requested a review from a team as a code owner September 28, 2026 16:36
@HofmeisterAn HofmeisterAn added the documentation Docs, docs, docs. label Sep 28, 2026
@netlify

netlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for testcontainers-dotnet ready!

Name Link
🔨 Latest commit a44236f
🔍 Latest deploy log https://app.netlify.com/projects/testcontainers-dotnet/deploys/6aba979a47b86800082a8b41
😎 Deploy Preview https://deploy-preview-1778--testcontainers-dotnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: 420f811d-c5a0-43b0-ba69-b517e98f0c82

📥 Commits

Reviewing files that changed from the base of the PR and between aabb0b0 and a44236f.

📒 Files selected for processing (40)
  • docs/api/best_practices.md
  • docs/api/builder_configurations.md
  • docs/api/connection_string_provider.md
  • docs/api/create_docker_container.md
  • docs/api/create_docker_image.md
  • docs/api/create_docker_network.md
  • docs/api/low_level_api_access.md
  • docs/api/resource_reuse.md
  • docs/api/wait_strategies.md
  • docs/cicd/index.md
  • docs/custom_configuration/index.md
  • docs/dind/index.md
  • docs/examples/aspnet.md
  • docs/modules/activemq.md
  • docs/modules/aspire-dashboard.md
  • docs/modules/cassandra.md
  • docs/modules/clickhouse.md
  • docs/modules/db2.md
  • docs/modules/elasticsearch.md
  • docs/modules/eventhubs.md
  • docs/modules/garnet.md
  • docs/modules/grafana.md
  • docs/modules/index.md
  • docs/modules/mongodb.md
  • docs/modules/mssql.md
  • docs/modules/neo4j.md
  • docs/modules/opensearch.md
  • docs/modules/playwright.md
  • docs/modules/postgres.md
  • docs/modules/pulsar.md
  • docs/modules/qdrant.md
  • docs/modules/questdb.md
  • docs/modules/rabbitmq.md
  • docs/modules/redis.md
  • docs/modules/servicebus.md
  • docs/modules/toxiproxy.md
  • docs/modules/valkey.md
  • docs/test_frameworks/xunit_net.md
  • examples/Flyway/README.md
  • examples/Respawn/README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.


Walkthrough

Documentation updates revise builder-method references and standardize headings and example labels. Some module pages also remove test-project callouts or change code-fence formatting. The described examples, settings, and guidance are otherwise unchanged.

Changes

Documentation updates

Layer / File(s) Summary
Builder method references
docs/api/create_docker_container.md, docs/api/create_docker_image.md, docs/api/create_docker_network.md
The supported-method tables add several builder methods and remove two entries from the container table. The network table marks WithReuse as experimental.
API and guide wording
docs/api/*, docs/cicd/index.md, docs/custom_configuration/index.md, docs/dind/index.md, docs/examples/aspnet.md
Headings, capitalization, and terminology change across API and guide pages. Documented settings, defaults, and guidance remain unchanged.
Module and example pages
docs/modules/*, docs/test_frameworks/xunit_net.md, examples/Flyway/README.md, examples/Respawn/README.md
Module and example pages update tab labels, headings, and display names. The Garnet and Valkey pages remove test-project callouts. Selected code-fence lines also change.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to a4423

The documentation-only changes are mergeable; the remaining wording concerns are optional editorial improvements.

Architecture Summary

Architecture risk: 🔵 Low · up to a4423

The change affects 2 systems.

Changed systems: docs, examples

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 38 changed files map to changed impact.
  • observed — examples (service) was modified; 2 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/api/best_practices.md: The document heading changes capitalization from “Best Practices” to “Best practices.”
  • observed — Modified behavior in docs/api/builder_configurations.md: The document title now emphasizes combining builder configurations instead of builder configurations generally.
  • observed — Modified behavior in docs/api/connection_string_provider.md: Changed the title and introductory sentence capitalization; the description of the provider API is otherwise unchanged.
  • observed — Modified behavior in docs/api/connection_string_provider.md: Capitalized “Builder” in the “Generic Builder” tab label.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the required headings, but the mandatory What does this PR do? and Why is it important? sections contain only placeholders. The Related issues section is also empty, and no te… Describe the documentation changes and their motivation in the two mandatory sections. Add related issue references if applicable, and document how reviewers can validate the changes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main changes: completing builder API tables and aligning heading casing across the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description includes the required headings, but the mandatory What does this PR do? and Why is it important? sections contain only placeholders. The Related issues section is also empty, and no testing details are provided.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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

A rabbit reads each heading bright
Then checks the builder tables right
Tabs now wear a newer case
Callouts leave in two spots’ place
The docs hop on, neat as can be

Comment @coderabbitai help to get the list of available commands.

@HofmeisterAn
HofmeisterAn merged commit 3bab1dc into develop Sep 28, 2026
8 checks passed
@HofmeisterAn
HofmeisterAn deleted the docs/complete-builder-api-tables branch September 28, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, docs, docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant