Readme examples minor

[predic8]

Summary by CodeRabbit

• Documentation
  • Updated and expanded documentation across multiple README files, including a new section promoting an API Gateway eBook and improved organization of example topics.
  • Added new overview documents for extension and security examples, providing clearer guidance and easier navigation.
  • Restructured the distribution examples documentation for better thematic grouping and usability.
  • Revised roadmap to improve clarity and organization of upcoming features and changes.

[coderabbitai]

Walkthrough

This update restructures and enhances documentation across several README files, introducing new overview and index documents for example directories, reorganizing content for clarity, and correcting or improving example references. The docs/ROADMAP.md file is also reorganized for better version tracking. No technical or code changes are included.

Changes

Cohort / File(s)	Change Summary
Main Project README Update README.md	Added API Gateway eBook promotion, improved phrasing and formatting, corrected and deepened example links, and made minor textual and layout edits.
Examples Index Restructure distribution/examples/README.md	Rewrote and expanded the examples index, grouping examples by feature areas, removing explicit directory listings, and providing a narrative overview.
Extending Membrane Examples Documentation distribution/examples/extending-membrane/README.md	Introduced a new README summarizing extension and configuration topics, including plugin chains, error handling, service discovery, and custom Java plugins.
Security Examples Documentation distribution/examples/security/README.md	Added a new README summarizing security example topics such as authentication, API keys, CORS, and access control.
Roadmap Reorganization docs/ROADMAP.md	Reordered changelog sections, added "(TB)" annotations, expanded some entries, and made minor formatting changes.

Sequence Diagram(s)

No sequence diagram generated, as the changes are limited to documentation structure and content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Readme examples minor #2028: Updates README.md files, focusing on improving example links and restructuring documentation, closely mirroring the scope of this PR.

Suggested reviewers

• t-burch

Poem

In the warren of docs, a bunny hops through,
Tidying READMEs, making old things feel new.
With links corrected and topics all neat,
Security and plugins now easy to meet.
Roadmaps in order, examples in sight—
This doc-loving rabbit has set things right!
🐇✨📚

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch readme-examples-minor

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

The merge-base changed after approval.

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

README.md (1)

1096-1122: Duplicate “Monitoring with Prometheus and Grafana” section

The identical heading appears twice (Lines 1098 and 1119). This dilutes navigation, and one copy already contains the full example link.

Delete the second occurrence (or merge new content into the first) to keep the TOC tidy.

🧹 Nitpick comments (5)

README.md (3)

80-83: Missing list marker breaks markdown rendering

**Admin Web Console** for monitoring and management. is missing the leading - used by the surrounding bullet items, so the line is rendered as a normal paragraph instead of being part of the list.

-**Admin Web Console** for monitoring and management.
+- **Admin Web Console** for monitoring and management.

---

70-70: Inconsistent anchor casing triggers MD051

#API-Keys is flagged because GitHub generates the anchor #api-keys (lower-case).
Updating the fragment avoids the markdown-lint warning and keeps anchors uniform.

-[API Keys](#API-Keys)
+[API Keys](#api-keys)

Also applies to: 120-120

---

1130-1130: Minor phrasing – “take a look” is preferred

-... have a look at [examples/prometheus] ...
+... take a look at [examples/prometheus] ...

distribution/examples/security/README.md (1)

19-20: Hyphenate compound adjective “Form-based”

-* [Form based login](login)
+* [Form-based login](login)

distribution/examples/README.md (1)

74-76: Redundant heading text

### XML(xml) repeats the word in parentheses and looks like a typo. A plain heading is sufficient:

-### XML(xml)
+### XML

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb4c4f8 and 4ad9b87.

⛔ Files ignored due to path filters (1)

• docs/images/api-gateway-ebook-cover.jpg is excluded by !**/*.jpg

📒 Files selected for processing (5)

• README.md (12 hunks)
• distribution/examples/README.md (1 hunks)
• distribution/examples/extending-membrane/README.md (1 hunks)
• distribution/examples/security/README.md (1 hunks)
• docs/ROADMAP.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

70-70: Link fragments should be valid
Expected: #api-keys; Actual: #API-Keys

(MD051, link-fragments)

🪛 LanguageTool

README.md

[locale-violation] ~1130-~1130: In American English, “take a look” is more commonly used.
Context: ...ete example with prometheus and Grafana have a look at [examples/prometheus](distribution/e...

(HAVE_A_LOOK)

🔇 Additional comments (2)

docs/ROADMAP.md (1)

48-51: Target directory looks inconsistent

The bullet says to “import in examples/prometheus” but the follow-up line says to “place it in examples/monitoring-tracing/graphql”.
Verify which folder is correct and adjust one of the paths to prevent future confusion.

distribution/examples/extending-membrane/README.md (1)

21-24: Link slug appears to be miss-typed

file-exchangestore is missing a hyphen compared to the actual example folder file-exchange-store/.

-* [File ExchangeStore](file-exchangestore)
+* [File ExchangeStore](file-exchange-store)

Do the same check for mongo-exchange-store if necessary.