update(roadmap): consolidate and prioritize goals across tutorials, Y… by predic8 · Pull Request #2623 · membrane/api-gateway

predic8 · 2026-01-16T11:52:09Z

…AML handling, and proxy/reuse performance improvements

Summary by CodeRabbit

Documentation
- Reorganized and consolidated the project roadmap into explicit PRIO 1 / PRIO 2 / PRIO 3 sections.
- Added prioritized items including tutorials, YAML improvements, error message guidance, and environment-variable documentation prompts.
- Reclassified and moved several legacy topics, adjusted item statuses and markers, and removed or de-emphasized outdated entries.

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

…AML handling, and proxy/reuse performance improvements

coderabbitai · 2026-01-16T11:52:21Z

📝 Walkthrough

Walkthrough

Updated project roadmap document: reorganized and consolidated items into explicit PRIO 1, PRIO 2, and PRIO 3 sections; added and reclassified numerous task bullets related to tutorials, YAML handling, error messages, environment variables, publishing, and monitoring notes.

Changes

Cohort / File(s)	Summary
Roadmap document `docs/ROADMAP.md`	Reworked roadmap structure into PRIO 1 / PRIO 2 / PRIO 3 blocks; added Dockerized tutorials, YAML improvements and validation notes, error message refinements, environment-variable documentation prompts, Maven/JMX items; reclassified or removed several legacy bullets. Net change: +54/-149 lines (editorial).

Sequence Diagram(s)

(omitted — changes are documentation-only and do not introduce new multi-component control flow)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

updated ROADMAP #2411: Edits to docs/ROADMAP.md with overlapping roadmap item reorganizations.
ROADMAP.md edit #2557: Editorial reorganization of roadmap entries and priorities affecting similar bullets.
Update(roadmap): add new features and improvements for tutorials, YAM… #2614: Adds Tutorials and YAML-related roadmap items that overlap with this PR.

Suggested reviewers

christiangoerdes
rrayst

Poem

🐇 I hopped through lines and sorted the trail,
PRIO flags pinned each task without fail,
Tutorials baked, YAML made bright,
Docs trimmed and set for flight,
A rabbit’s roadmap — tidy and hale.

🚥 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 clearly and specifically summarizes the main change—consolidating and prioritizing goals in the roadmap across three key areas: tutorials, YAML handling, and performance improvements.
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.}

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.}

coderabbitai

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In `@docs/ROADMAP.md`:
- Line 35: Replace the misspelled word "Examle" with the correct spelling
"Example" in the ROADMAP document (look for the heading or line containing
"Examle" in docs/ROADMAP.md) so the text reads "Example".
- Line 46: Fix the typo in the ROADMAP text: change the phrase "Language is case
sensitve: e.g. language: SPEL is not valid according to the Schema and produces:
TB" to use "sensitive" instead of "sensitve" (update the sentence that starts
with "Language is case sensitve" in docs/ROADMAP.md).
- Line 43: Update the typo in the ROADMAP entry string "Migrate deprecated
finally to try with ressources" by replacing "ressources" with the correct
spelling "resources" so the line reads "Migrate deprecated finally to try with
resources".
- Line 21: Update the typo in the ROADMAP.md entry that currently reads "Central
desciption of MEMBRANE_* environment variables" to "Central description of
MEMBRANE_* environment variables" so the word "desciption" is corrected to
"description" in the document.
- Around line 22-23: Document all MEMBRANE_* environment variables grouped into
categories: installation/runtime (e.g., MEMBRANE_HOME, MEMBRANE_CALLER_DIR,
MEMBRANE_REQUIRED_JAVA_VERSION), logging/output (e.g.,
MEMBRANE_DISABLE_TERM_COLORS, MEMBRANE_TERM_COLORS, MEMBRANE_LOG_LEVEL),
feature-specific (e.g., MEMBRANE_VALIDATION, MEMBRANE_OAUTH, MEMBRANE_OTEL_*,
MEMBRANE_HTTPCLIENT_BUFFER_SIZE), and internal/generated (e.g.,
MEMBRANE_GENERATE_DOC_DIR, MEMBRANE_SCHEMA_JSON_FILENAME); for each variable
include purpose, default/expected values, validation rules, and example usage
snippets drawn from distribution scripts, and add a note/instruction that any
shell scripts referencing MEMBRANE_HOME must validate the directory contains
expected files (for example starter.jar) before proceeding to avoid runtime
errors.

🧹 Nitpick comments (1)

docs/ROADMAP.md (1)
18-18: Consider using markdown link syntax for the URL.

The bare URL can be formatted as a markdown link for better readability and to satisfy markdown linting rules.
📝 Proposed formatting improvement
-- Register JSON Schema for YAML at: https://www.schemastore.org TB
+- Register JSON Schema for YAML at [schemastore.org](https://www.schemastore.org) TB

📜 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 d338822 and afb3d5a.

📒 Files selected for processing (1)

docs/ROADMAP.md

🧰 Additional context used

🪛 LanguageTool

docs/ROADMAP.md

[grammar] ~12-~12: Ensure spelling is correct
Context: ... run the tutorials in a Docker container - HotReload for YAML - YAML parsing: - Shorten YA...