docs: add roadmap and automate deep wiki updates

[K1ngst0m]

Summary by CodeRabbit

• Documentation
  • Added badge link to the README.
  • Added Roadmap link under Documentation section.
  • Introduced comprehensive Roadmap document with project vision, development phases, and technical goals including shader support and latency optimization initiatives.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updates adding project planning artifacts: a badge link and Roadmap reference to README.md, and a comprehensive new ROADMAP.md file with development phases, acceptance criteria, and long-term project vision.

Changes

Cohort / File(s)	Summary
Documentation & Project Planning README.md, ROADMAP.md	README updated with badge link and Roadmap reference; new ROADMAP.md introduces phased development plan with Phase 1 (validation, profiling, error handling, parameter control) and Phase 2 (network streaming) goals and concrete checklists

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A roadmap unfurls, so shiny and bright,
Plans for the future, laid out just right,
Phases and badges in markdown we trust,
Hopping through timelines, because grow we must! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title mentions adding a roadmap and automating wiki updates, but the changes only include adding a roadmap (ROADMAP.md) and updating README with a badge and roadmap link. The 'automate deep wiki updates' part is not evident in the actual changes.	Clarify whether wiki automation was actually implemented. If not implemented, consider revising the title to 'docs: add roadmap and update README' or provide implementation details for the automation aspect.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev/kingstom/add-roadmap

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

ROADMAP.md (3)

17-17: Specify language for fenced code block.

The example block at line 17 is missing a language identifier. While it's a placeholder section, specifying the intended language (e.g., yaml, shell, or text) improves rendering and follows markdown best practices.

🔎 Proposed fix

-```
+```yaml

As per markdownlint-cli2 (0.18.1) guidelines, MD040 recommends specifying language identifiers for accessibility and consistency.

---

60-60: Use hyphen for compound adjective.

Line 60 should use a hyphen to join the words: "Config file-based parameter overrides" instead of "Config file based parameter overrides".

🔎 Proposed fix

-  - [ ] Config file based parameter overrides
+  - [ ] Config file-based parameter overrides

As per LanguageTool grammar checking, properly hyphenating compound adjectives improves readability and follows standard English conventions.

---

61-61: Specify language for fenced code block.

The code block reference at line 61 is missing a language identifier. Since this links to a GitHub pull request context, consider specifying a language (e.g., markdown or text) for consistency.

🔎 Proposed fix

-```
+```markdown

As per markdownlint-cli2 (0.18.1) guidelines, MD040 recommends specifying language identifiers for accessibility and consistency.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44d4ef9 and 5281995.

📒 Files selected for processing (2)

• README.md
• ROADMAP.md

🧰 Additional context used

🪛 LanguageTool

ROADMAP.md

[grammar] ~60-~60: Use a hyphen to join words.
Context: ... and preset selection - [ ] Config file based parameter overrides - [ ] CLI argu...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

ROADMAP.md

17-17: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

61-61: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ 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: Static Analysis (clang-tidy)
• GitHub Check: Build and Test

🔇 Additional comments (5)

README.md (2)

3-3: Badge link added successfully.

The DeepWiki badge integrates naturally at the top of the README and follows standard markdown link syntax. This provides a helpful entry point for community integration.

---

129-129: Roadmap link follows existing documentation convention.

The new Roadmap link under the Documentation section aligns with the pattern of other topic-specific doc references and correctly points to the new ROADMAP.md file.

ROADMAP.md (3)

3-26: Well-structured long-term vision.

The Long Term section establishes clear goals with helpful context. The shader support rule and latency optimization areas are well-articulated with concrete examples for measurement focus.

---

27-67: Phase 1 planning is clear and actionable.

The four work items (Shader Validation & Testing, Tracy Profiling, Error Traceback, Shader Parameter Control) each have detailed checklists with concrete acceptance criteria. The cross-references to code paths and external PRs (#12) help ground the work in the existing codebase.

---

69-77: Phase 2 vision is forward-looking.

The Network Streaming section outlines a clear direction with reasonable potential approaches (GStreamer, RTSP, WebRTC, hardware encoding). The note about Moonlight/Sunshine protocol compatibility adds practical context for future exploration.