Repository navigation
Consolidate docs snippets with runnable examples and fix broken mockserver snippet - #12105
Yusuf-Hussien wants to merge 1 commit into
Conversation
…erver snippet Add missing ollama-hugging-face entry to docs/examples.md, link module docs pages to matching examples/ projects, replace hand-typed inline snippets with codeincludes of runnable code, and restore the missing testSimpleExpectation marker so the mockserver docs snippet renders again.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (9)
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughThe documentation adds links to runnable examples and replaces two inline integration examples with source includes. Marker comments were added around an existing MockServer expectation; its executable behavior is unchanged. ChangesExample documentation
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~8 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation references and snippets align with their example sources; no concrete issue remains that should block merging. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (8 skipped: 8 unsupported.)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
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 |
Part of #1167
First batch of consolidation between the docs and the
examples/folder: improve discoverability and replace hand-typed snippets with codeincludes of runnable code.Discoverability
examples/ollama-hugging-faceentry todocs/examples.md(16 projects existed, only 15 were listed)docs/modules/kafka.md→examples/kafka-cluster(multi-broker setup not covered by the page)docs/modules/solr.md→examples/solr-containerdocs/modules/databases/neo4j.md→examples/neo4j-containerdocs/modules/ollama.md→examples/ollama-hugging-facedocs/modules/webdriver_containers.md→examples/selenium-containerdocs/test_framework_integration/manual_lifecycle_control.md→examples/singleton-containerSnippet deduplication (inline → codeinclude)
docs/test_framework_integration/junit_4.md: the@Ruleexample is now embedded fromdocs/examples/junit4/redis/src/test/java/quickstart/RedisBackedCacheIntTest.java(inside_block:rule) instead of being hand-typeddocs/test_framework_integration/manual_lifecycle_control.md: the singleton pattern is now embedded fromexamples/singleton-container/src/test/java/com/example/AbstractIntegrationTest.java(block:AbstractIntegrationTest), which is built in CI, instead of a duplicated inline copyBroken snippet fix
docs/modules/mockserver.mdreferencesinside_block:testSimpleExpectation, but that token did not exist inMockServerContainerTest, so the "setting a simple expectation" snippet has not been rendering at all. Added the// testSimpleExpectation { ... // }marker around the corresponding lines (same marker style as the existingcreatingProxymarker in that file).Verification
mkdocs build(perdocs/contributing_docs.md) succeeds locallyPossible follow-ups (not included here)
docs/examples/junit4/genericanddocs/examples/junit4/redisare not listed insettings.gradle, so most docs snippet sources are not compile-checkeddocs/examples/junit4/generic/.../ContainerCreationTest.javadefines snippet markers that no page usesSummary by CodeRabbit