docs: update documentation

[K1ngst0m]

User description

• Convert ASCII diagrams to Mermaid format in architecture, dmabuf_sharing, filter_chain, input_forwarding, and retroarch docs
• Update input forwarding documentation to reflect wlroots/seat-based delivery (vs legacy XTest)
• Update dependency management references from CPM/Conan to Pixi-based workflow
• Simplify README overview and add input forwarding primer reference
• Update CLI flag description for --input-forwarding (wlroots compositor)
• Refresh project_policies.md timestamps and configuration examples

---

PR Type

Documentation, Enhancement

---

Description

• Convert ASCII diagrams to Mermaid format across architecture, DMA-BUF, filter chain, input forwarding, and RetroArch docs

• Update input forwarding implementation from XTest injection to wlroots seat-based delivery

• Migrate dependency management from CPM/Conan hybrid to Pixi-based workflow

• Simplify README overview and add input forwarding primer documentation reference

• Update CLI flag and configuration examples to reflect wlroots compositor approach

• Refresh project policies with current threading model and dependency strategy

---

Diagram Walkthrough

flowchart LR
  Docs["Documentation files"]
  ASCII["ASCII diagrams"]
  Mermaid["Mermaid flowcharts"]
  
  InputOld["XTest-based input"]
  InputNew["wlroots seat-based input"]
  
  DepOld["CPM/Conan hybrid"]
  DepNew["Pixi environment"]
  
  Docs --> ASCII
  ASCII --> Mermaid
  
  InputOld --> InputNew
  DepOld --> DepNew

Loading

File Walkthrough

	Relevant files
Documentation	9 files cli.hpp Update input forwarding CLI flag description                          +1/-1      README.md Simplify overview and add documentation links                        +8/-54    goggles.toml Update input forwarding configuration documentation            +2/-1      architecture.md Convert ASCII diagram to Mermaid flowchart                              +32/-28  dmabuf_sharing.md Convert ASCII diagrams to Mermaid flowcharts                          +38/-35  filter_chain_workflow.md Convert ASCII diagrams to Mermaid flowcharts                          +17/-33  input_forwarding.md Convert ASCII diagrams to Mermaid, update XTest references +36/-71  project_policies.md Update dependency strategy and threading documentation      +27/-73  retroarch.md Convert ASCII diagrams to Mermaid flowcharts                          +26/-35
Dependencies	1 files Dependencies.cmake Remove XTest dependency, update wlroots comment                    +1/-6

---

Summary by CodeRabbit

• Documentation
  • Modernized architectural diagrams and workflows with flowcharts for improved clarity
  • Simplified and enhanced quick-start commands with new input-forwarding option
  • Expanded documentation with new topic links and project resources
  • Refined input forwarding system documentation and descriptions
  • Updated CLI help text for the input forwarding flag

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR updates documentation, build instructions, configuration comments, and CLI help text to reflect migration from X11/XTest-based input forwarding to wlroots + XWayland seat-level input delivery. ASCII diagrams are replaced with Mermaid visualizations across multiple documentation files.

Changes

Cohort / File(s)	Summary
Documentation Diagrams docs/architecture.md, docs/dmabuf_sharing.md, docs/filter_chain_workflow.md, docs/retroarch.md	ASCII diagrams replaced with Mermaid flowcharts and sequence diagrams; component interactions reformatted without semantic changes.
Input Forwarding Documentation docs/input_forwarding.md	Mermaid diagrams added; socket naming changed from wayland-N to goggles-N; dependency framing shifted from system packages to Pixi environment; XTest references removed in favor of wlroots XWayland integration.
Policy Documentation docs/project_policies.md	Threading model description updated; configuration structure examples refactored; dependency management approach changed from CPM.cmake + Conan hybrid to Pixi-managed environment; cross-references updated to reflect new tooling.
Root Documentation README.md	Architectural description condensed to single-liner; quick-start commands updated to new format with -- separator; input-forwarding examples added; Shader Compatibility Report linked; documentation navigation expanded with new topic links.
Dependencies & Configuration cmake/Dependencies.cmake, config/goggles.toml	X11 package lookup removed; input-forwarding mechanism comments updated to reference nested wlroots compositor; XTest-related error flow removed.
CLI Help Text src/app/cli.hpp	--input-forwarding flag description updated from "nested XWayland + XTest injection" to "nested wlroots compositor with XWayland".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Add Input Forwarding (X11 app) #11: Introduced wlroots + XWayland input-forwarding implementation with dependency setup—this PR documents and configures that subsystem migration.
• Add Wayland Native Input Forwarding #32: Migrated input-forwarding from X11/XTest to wlroots + XWayland seat-based delivery—this PR updates documentation, CMake deps, and CLI text to align with that change.
• docs: add roadmap and automate deep wiki updates #18: Added Roadmap link in README—this PR also updates README with expanded documentation navigation including Roadmap entry.

Suggested labels

documentation, configuration, dependencies, input-forwarding

Poem

🐰 Mermaid diagrams flow with grace,
ASCII art bows in its place,
Goggles now sees through wlroots' eyes,
From X11 tests to Wayland skies,
Socket names sing—goggles-N bright! ✨

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9cc47b5 and e72150b.

📒 Files selected for processing (10)

• README.md
• cmake/Dependencies.cmake
• config/goggles.toml
• docs/architecture.md
• docs/dmabuf_sharing.md
• docs/filter_chain_workflow.md
• docs/input_forwarding.md
• docs/project_policies.md
• docs/retroarch.md
• src/app/cli.hpp

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Use compatible HTML line breaks Replace the self-closing tag with in a Mermaid diagram for better renderer compatibility. docs/filter_chain_workflow.md [13] -Original["Original frame<br/>(imported image)"] +Original["Original frame<br>(imported image)"] Apply / Chat Suggestion importance[1-10]: 4 __ Why: The suggestion improves Mermaid diagram compatibility by replacing a self-closing <br/> tag with <br>, which is more widely supported.	Low
More