Readme examples minor #2030
Readme examples minor #2030
Conversation
# Conflicts: # core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/JDBCApiKeyStore.java
WalkthroughThis update restructures and expands documentation across multiple README files, introducing new guides for security and extension examples, reorganizing the main example index, and refining the primary project README. Additionally, the ROADMAP is clarified by properly separating version entries. No code or configuration logic is modified. Changes
Sequence Diagram(s)No sequence diagram generated since all changes are documentation-only and do not affect control flow or introduce new features. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (3)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
distribution/examples/security/README.md (1)
8-9: Use a consistent bullet marker to silence markdown-lint MD004The outer list uses
*, but the nested list switches to-, triggering the lint warning.
Align the marker style to keep tooling quiet and the style guide consistent.- - Use different OAuth2 flows with APIs - - Authentication and authorization with JWT, OAuth2 and OpenID Connect + * Use different OAuth2 flows with APIs + * Authentication and authorization with JWT, OAuth2 and OpenID Connectdocs/ROADMAP.md (1)
37-45: Clarify “TB” placeholders and polish wordingSeveral items are suffixed with “TB”, which looks like an unfinished “TBD”.
If they are meant to signal “to be done”, rename to “TBD” and consider short action verbs to make the roadmap easier to scan.Example:
- - Refactor MessageUtil (TB) + - Refactor MessageUtil (TBD)README.md (1)
58-60: Remove leading slash in image path to keep it repo-relativeUsing
/docs/...makes the link absolute to the GitHub domain root, which breaks when the README is viewed outside GitHub (e.g., npmjs.com).
A relative path keeps the image portable.- +Please double-check that the image exists under
docs/images/.distribution/examples/extending-membrane/README.md (1)
1-2: Add a concise intro paragraph for better contextOpening directly with the headline jumps into the TOC without briefly explaining what “extending Membrane” means or how this guide fits into the overall example hierarchy. A one-sentence overview will help newcomers understand why they should keep reading.
# Configuration and Extension Examples for Membrane API Gateway + +These examples show how to adapt, customize, and embed Membrane for real-world scenarios beyond basic reverse-proxy usage.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/api-gateway-ebook-cover.jpgis excluded by!**/*.jpg
📒 Files selected for processing (5)
README.md(11 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)
distribution/examples/security/README.md
8-8: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
9-9: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (3)
README.md (1)
1101-1110: Prometheus example path is validThe
distribution/examples/monitoring-tracing/directory is present, so the link
[Prometheus and Grafana example](distribution/examples/monitoring-tracing/prometheus)
resolves correctly. No further changes required.distribution/examples/README.md (1)
1-4: Great re-organisation!The new task-oriented structure is much clearer and easier to navigate.
Nice work.distribution/examples/extending-membrane/README.md (1)
5-35: README structure looks clear and well-organizedLinks, section grouping, and phrasing are consistent with the other example READMEs added in this PR. Nice work.
2 participants
Summary by CodeRabbit