Skip to content

Update(roadmap): add new features and improvements for tutorials, YAM…#2614

Merged
christiangoerdes merged 3 commits into
masterfrom
roadmap-edit-2
Jan 16, 2026
Merged

Update(roadmap): add new features and improvements for tutorials, YAM…#2614
christiangoerdes merged 3 commits into
masterfrom
roadmap-edit-2

Conversation

@predic8
Copy link
Copy Markdown
Member

@predic8 predic8 commented Jan 14, 2026

…L handling, and error tolerance

Summary by CodeRabbit

  • Documentation
    • Added Tutorials subsection under YAML/StreamTracing in the roadmap
    • Added instructions for running tutorials in Docker containers
    • Documented HotReload support for YAML
    • Clarified YAML behavior: suggested HTTP methods, tolerant handling of trailing separators, case-sensitive language values, and http/https options for rewrites/protocols
    • Replaced a previous blank separation after StreamTracing with the new Tutorials content

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 14, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Adds a Tutorials subsection under YAML/StreamTracing in docs/ROADMAP.md, documenting Docker-based tutorial execution, HotReload for YAML, YAML method suggestions, handling of trailing ---, case-sensitive language enum errors, and openapi/rewrite/protocol options (http/https).

Changes

Cohort / File(s) Summary
Documentation Updates
docs/ROADMAP.md
Inserted a Tutorials subsection under YAML/StreamTracing. Added items: Docker tutorial instructions, HotReload for YAML, YAML notes on method suggestions (GET/POST/etc.), tolerant handling of trailing ---, case-sensitive language enum (example error message), and openapi/rewrite/protocol options (http/https).

Sequence Diagram(s)

(omitted — documentation-only change)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • rrayst

Poem

🐰 I hopped through lines of roadmap text with glee,
Docker, HotReload, and YAML notes you see.
Methods suggested, trailing dashes tamed,
Case-sensitivity neatly named.
Hop in—these docs will guide you free! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding new features and improvements to the roadmap, specifically for tutorials and YAML handling.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.



📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 88c401d and 9a53185.

📒 Files selected for processing (1)
  • docs/ROADMAP.md

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/ROADMAP.md`:
- Line 37: Fix the typo in the sentence containing "Language is case sensitve:
e.g. language: SPEL is not valid according to the Schema and produces:" in
docs/ROADMAP.md by replacing "sensitve" with "sensitive" so the line reads
"Language is case sensitive: e.g. language: SPEL is not valid according to the
Schema and produces:".
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f9f1c3 and 3ee06a9.

📒 Files selected for processing (1)
  • docs/ROADMAP.md
🧰 Additional context used
🪛 LanguageTool
docs/ROADMAP.md

[grammar] ~37-~37: Ensure spelling is correct
Context: ...erantly ignore it. - Language is case sensitve: e.g. language: SPEL is not valid accord...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ 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)

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Comment thread docs/ROADMAP.md
@christiangoerdes christiangoerdes merged commit a462cf3 into master Jan 16, 2026
2 of 3 checks passed
@christiangoerdes christiangoerdes deleted the roadmap-edit-2 branch January 16, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants