docs: New Roadmap #2020
docs: New Roadmap #2020
Conversation
WalkthroughThe roadmap documentation was thoroughly updated to reflect revised and reorganized plans for future versions. Version milestones were advanced and clarified, with new features, internal refactorings, and deprecated items consolidated or reformulated. Formatting, duplicate entries, and outdated notes were cleaned up, but no code or APIs were changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
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
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)
docs/ROADMAP.md (4)
3-8: Use fenced code blocks for method-signature diffsShowing a Java signature diff inside normal Markdown text is hard to read. Wrap the original and new signatures in a fenced
javacode block or inline back-ticks so that they’re rendered monospace and are easily copy-pasted.- Change Signature: public Exchange call(Exchange exc) throws Exception - => public void call(Exchange exc) throws Exception { +```java +// before +public Exchange call(Exchange exc) throws Exception; + +// after +public void call(Exchange exc) throws Exception; +```
12-12: Spelling typo in JSONPath example
<mask>$.cusomter.payment.creditcard→customer- <mask>$.cusomter.payment.creditcard +<mask>$.customer.payment.creditcard
48-48: Fix heading level jump (MD001)The previous heading is
# 6.3.0(H1). Jumping straight to### Internal(H3) violates the “increment by one” rule. Change to## Internal.-### Internal +## Internal
50-50: Avoid bare URL (MD034)Convert the raw URL into an inline link to keep the document lint-clean and user-friendly.
- - new Namespace e.g. https://membrane-api.io...6 + - new Namespace (e.g. <https://membrane-api.io…6>)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/ROADMAP.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/ROADMAP.md
48-48: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
50-50: Bare URL used
(MD034, no-bare-urls)
⏰ 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). (2)
- GitHub Check: Automated tests
- GitHub Check: Analyze (java)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/ROADMAP.md (4)
3-9: Normalize heading hierarchy to avoid MD001 violations
The document already has a top-level title on Line 1. The version titles that follow should therefore be second-level (##) headings, not first-level (#), to keep the hierarchy consistent and silence markdown-lint.-# 7.0.0 +# ## 7.0.0 … -# 6.5.0 +# ## 6.5.0
5-7: Render method signatures as fenced code for readability
Without back-ticks the<and>can be interpreted as HTML and the long line wraps badly.- - Change Signature: public Exchange call(Exchange exc) throws Exception - => public void call(Exchange exc) throws Exception { + - Change Signature: + ```java + // before + public Exchange call(Exchange exc) throws Exception; + + // after + public void call(Exchange exc) throws Exception; + ```
14-16: Escape XML-like tags to prevent them being treated as HTML
The raw<apiKey/>and<scriptXX>will be swallowed by many Markdown renderers. Fence them or escape the angle brackets.-- <apiKey/> - <scriptXX>${json[key]}</scriptXX> +- ```xml + <apiKey/> + <scriptXX>${json[key]}</scriptXX> + ```
21-23: Tighten wording for the Cookie refactor task
Grammatically unclear: “Cookie maybe centralize Cookie Handling in a Cookie class”. Streamline for immediate comprehension.-- Refactor: Cookie maybe centralize Cookie Handling in a Cookie class +- Refactor Cookie handling: centralize logic in a dedicated `Cookie` helper class
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/ROADMAP.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/ROADMAP.md
56-56: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
58-58: Bare URL used
(MD034, no-bare-urls)
⏰ 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)
2 participants
Summary by CodeRabbit