docs: add per-example READMEs and slim the examples showcase#943
Merged
Conversation
Add a brief README.md to each runnable example under examples/ describing its scope, pipeline (as a mermaid flowchart), prerequisites, and run command. 24 new READMEs plus 4 existing ones (postgresql, redis_cursor, metadata_regex_filter, wasm_basic) reshaped to the same template. With per-example READMEs now serving as the detail pages behind the showcase, drop the now-duplicated "Companion files & setup" section and the "Setup" column from docs/v2/examples/index.mdx, leaving a clean Example | What it shows catalog plus the inline recipes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (29)
📝 WalkthroughWalkthroughAdds or rewrites ChangesExamples Documentation Overhaul
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
✨ 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 |
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
Every runnable example under
examples/now ships a briefREADME.mdcovering its scope, pipeline (as a mermaid flowchart), prerequisites, and run command.assert,aws_lambda,aws_s3,aws_sqs,dolos_source,elasticsearch,file_cursor,file_rotate,gcp_cloudfunction,gcp_pubsub,hydra,into_json,kafka,metrics,mithril,n2c_source,parse_cbor,redis,select,sqlite,stdout,webhook_basics,zeromq,rabbitmq.postgresql(psql/init.sql),redis_cursor(Demeter tunnel),metadata_regex_filter(regex patterns),wasm_basic(tinygo build).examples/lib/(its own tailored README) andexamples/_deprecated/*.Each pipeline diagram was verified against the example's actual
daemon.toml, and cargo feature flags againstCargo.toml. Run commands use the installed-binary form, pluscargo run --features <feat>where a feature flag is required.Showcase doc cleanup
With the per-example READMEs now serving as the detail pages behind the showcase links,
docs/v2/examples/index.mdx:The "Running an example" guidance, the inline TOML recipes, and the "As a library" section are kept.
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation