docs(Redis): Add example#1641
Merged
HofmeisterAn merged 5 commits intodevelopfrom Feb 28, 2026
Merged
Conversation
✅ Deploy Preview for testcontainers-dotnet ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Repository UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
WalkthroughAdds three new module docs (Garnet, Redis, Valkey), updates the modules index and mkdocs navigation, normalizes Markdown admonition spacing across docs, and makes minor test edits (GUID formatting and comment region markers). No public API or behavioral changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ❌ 5❌ Failed checks (3 warnings, 2 inconclusive)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/modules/garnet.md`:
- Around line 6-8: Update the MkDocs markup in the Garnet module text: change
the admonition token `!!!note` to `!!! note` and fix the relative link
`(modules/redis/)` to use the site-root relative path `/modules/redis/` so it
matches other module pages (search for the `!!!note` token and the
`(modules/redis/)` link in the Garnet content to locate the lines to edit).
In `@docs/modules/valkey.md`:
- Around line 6-8: Replace the incorrect Garnet wording and fix the Markdown
syntax: change the phrase "Garnet module" to "Valkey module", update the inline
link target from `modules/redis/` to the absolute path format
`(/modules/redis/)`, and correct the admonition marker `!!!note` to `!!! note`
(so the note block renders properly). Ensure these edits apply where the text
mentions `Testcontainers.Redis` and the surrounding admonition.
ℹ️ Review info
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
docs/modules/garnet.mddocs/modules/index.mddocs/modules/qdrant.mddocs/modules/redis.mddocs/modules/valkey.mdmkdocs.ymltests/Testcontainers.EventHubs.Tests/EventHubsContainerTest.cstests/Testcontainers.OpenSearch.Tests/OpenSearchContainerTest.cstests/Testcontainers.Redis.Tests/RedisContainerTest.cstests/Testcontainers.Redis.Tests/Testcontainers.Redis.Tests.csproj
This was referenced Feb 28, 2026
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/modules/valkey.md (1)
5-5:⚠️ Potential issue | 🟡 MinorCorrect copy-paste error: "Garnet module" should be "Valkey module".
Line 5 incorrectly references "Garnet module" in the Valkey documentation. This appears to be a copy-paste error from the Garnet docs.
📝 Proposed fix
-You can use the existing [`Testcontainers.Redis`](/modules/redis/) package without requiring a separate Garnet module. +You can use the existing [`Testcontainers.Redis`](/modules/redis/) package without requiring a separate Valkey module.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/modules/valkey.md` at line 5, The sentence in docs/modules/valkey.md incorrectly says "Garnet module" due to a copy-paste error; update that text to read "Valkey module" so the line reads that Testcontainers.Redis can be used without requiring a separate Valkey module (replace the phrase "Garnet module" with "Valkey module" in the affected sentence).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/modules/valkey.md`:
- Line 5: The sentence in docs/modules/valkey.md incorrectly says "Garnet
module" due to a copy-paste error; update that text to read "Valkey module" so
the line reads that Testcontainers.Redis can be used without requiring a
separate Valkey module (replace the phrase "Garnet module" with "Valkey module"
in the affected sentence).
ℹ️ Review info
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
docs/api/connection_string_provider.mddocs/api/create_docker_container.mddocs/api/create_docker_image.mddocs/api/resource_reaper.mddocs/api/resource_reuse.mddocs/api/wait_strategies.mddocs/custom_configuration/index.mddocs/modules/_call_out_test_projects.txtdocs/modules/garnet.mddocs/modules/valkey.mddocs/test_frameworks/xunit_net.mdmkdocs.yml
✅ Files skipped from review due to trivial changes (7)
- docs/api/create_docker_container.md
- docs/api/connection_string_provider.md
- docs/api/create_docker_image.md
- docs/custom_configuration/index.md
- docs/test_frameworks/xunit_net.md
- docs/api/wait_strategies.md
- docs/api/resource_reaper.md
🚧 Files skipped from review as they are similar to previous changes (1)
- mkdocs.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds a simple Redis example to the docs. It also includes a brief note about Garnet and Valkey, mentioning that both are compatible with the Redis module and don’t require a separate module at this time.
Why is it important?
-
Related issues
Summary by CodeRabbit
Documentation
Tests