You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: explain Vooya architecture across project homepages - #188
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.
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.
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 · 5
Passed checks (5 passed)
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title clearly summarizes the main documentation change: explaining Vooya’s architecture across project homepages. It is concise and specific.
Docstring Coverage
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
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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