Readme examples minor

[predic8]

Summary by CodeRabbit

• Documentation
  • Enhanced the main README with a new API Gateway eBook section, improved feature descriptions, and updated example paths and links for consistency.
  • Completely restructured the examples README to provide a more organized, categorized overview of available examples and usage scenarios.
  • Updated the roadmap to correctly separate and detail changes for versions 6.3.0 and 6.4.0, improving changelog clarity.

[coderabbitai]

Walkthrough

This update revises documentation files by restructuring and expanding example overviews, updating and correcting links, paths, and formatting in the main README, and reorganizing changelog entries in the roadmap. No changes were made to code or configuration; all updates are limited to documentation content and structure.

Changes

Cohort / File(s)	Change Summary
Main README updates README.md	Added API Gateway eBook section, revised features text, corrected and standardized example paths, updated links, and fixed formatting issues.
Examples documentation overhaul distribution/examples/README.md	Rewrote and reorganized the examples README into thematic sections with descriptive bullet points, replacing the previous table-based index.
Roadmap changelog reorganization docs/ROADMAP.md	Moved 6.3.0 changelog entries into a dedicated section, clarified distinctions between 6.3.0 and 6.4.0, and made minor additions regarding Grafana dashboard location.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

• rrayst

Poem

🐇 A hop through docs, a leap through time,
Paths now clear, examples prime.
Changelogs sorted, links aligned,
eBooks await for those inclined.
With every update, we bound ahead—
Let’s read, explore, and hop where led!

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.

[coderabbitai]

Actionable comments posted: 1

🔭 Outside diff range comments (1)

README.md (1)

1101-1134: Duplicate “Monitoring with Prometheus and Grafana” section creates noise.

The same H3 heading and almost identical instructions appear twice (Lines 1101-1114 and 1122-1134). Merge them into a single section to avoid reader confusion and maintenance overhead.

🧹 Nitpick comments (5)

docs/ROADMAP.md (1)

35-55: Consider removing internal placeholders such as “(TB)” before publishing.

Several bullet points still contain the marker “(TB)” (to-be-done). Leaving these in a public roadmap can be confusing for readers and gives the impression that the list is still draft-quality.
If these items really are open tasks, move them to an issue tracker instead and keep the roadmap concise.

README.md (3)

80-83: Missing list marker breaks Markdown list rendering.

Line 80 starts with bold text but lacks the leading “- ” used by the surrounding list items.

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

---

323-326: Typo: “Custum” → “Custom”.

-| `test` | - Custum script …
+| `test` | - Custom script …

---

1133-1134: Minor wording – “have a look” → “take a look”.

LanguageTool flagged this; the American English idiom is “take a look”.

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

distribution/examples/README.md (1)

74-77: Heading formatting: “### XML(xml)” looks accidental.

The parenthesis duplicates the word and renders oddly.

-### 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 8ba6381 and a64a467.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (3)

• README.md (10 hunks)
• distribution/examples/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] ~1133-~1133: 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)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (1)

README.md (1)

54-60: Verify e-book image/URL paths.

The image uses an absolute path /docs/images/api-gateway-ebook-cover.jpg and the PDF is linked directly from an external site.
• Make sure the image exists at that location inside the repository (GitHub will treat the leading “/” as repository-root).
• Consider pinning the PDF to a version tag or static location to avoid future 404s.