Skip to content

docs: explain Vooya architecture across project homepages - #188

Merged
CoderSerio merged 1 commit into
mainfrom
docs/readme-architecture
Oct 13, 2026
Merged

CoderSerio merged 1 commit into
mainfrom
docs/readme-architecture

Conversation

@CoderSerio

@CoderSerio CoderSerio commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Make the README a concise entry point and reuse an editable architecture SVG on both documentation homepages. The diagram separates build tooling from browser runtime, uses the correct Rspack mark, and labels experimental and planned integrations.

Add diagram editing guidance, an AGENTS.md execution guide, and conventional branch naming to CONTRIBUTING.

Verified: npm run verify:docs, npm run verify:branding, npm run docs:build, git diff --check, and the rendered documentation homepage.

Summary by CodeRabbit

  • Documentation
    • Updated the README with a concise overview of Vooya’s architecture, current scope, and quickstart links.
    • Added architecture guidance to the English and Chinese documentation, including how Vooya connects Rust/WASM to web frameworks and bundlers.
    • Expanded contributor guidance with repository navigation, verification, and pull request instructions.
    • Added maintainer guidance for updating and validating the architecture diagram.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b32f61bc-4490-4180-93b2-0db8372a3a07
📥 Commits

Reviewing files that changed from the base of the PR and between ad16bde and d032c72.

⛔ Files ignored due to path filters (1)
  • docs/public/architecture.svg is excluded by !**/*.svg
📒 Files selected for processing (6)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • docs/index.md
  • docs/maintainers/architecture-diagram.md
  • docs/zh-CN/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

This change adds repository and contribution guidance, replaces much of the README with a concise project overview, expands the English and Chinese documentation homepages, and adds maintainer guidance for the architecture diagram.

Changes: Project documentation and contributor guidance

Layer / File(s) Summary
Repository and contribution guidance
AGENTS.md, CONTRIBUTING.md
Adds repository navigation, focused-change and verification guidance, contribution preparation rules, and branch naming instructions.
Project overview and current scope
README.md, docs/index.md, docs/zh-CN/index.md
Updates the README and adds matching homepage content describing Vooya’s architecture, provider status, integrations, and browser runtime.
Architecture-diagram maintenance
docs/maintainers/architecture-diagram.md
Documents diagram source locations, editing and validation steps, and artwork attribution and licensing.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to d032c

The README’s Vite 8 wording is consistent with the project’s stated compatibility target. No actionable merge risk remains in the supplied documentation changes.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main documentation change: explaining Vooya’s architecture across project homepages. It is concise and specific.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@CoderSerio
CoderSerio merged commit 9c817d5 into main Oct 13, 2026
17 checks passed
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.

1 participant