Conversation
Updates Cargo.lock to reflect the 1.3.24 version bump for faro, faro-agent-proto, faro-agentd, and faro-cli.
There was a problem hiding this comment.
Pull request overview
This PR refreshes Faro’s public-facing documentation to match the ServerKit family README structure (hero poster, badges, nav, screenshot grids, feature tables, support/related/community/footer) while also bumping the Rust crate versioning to v1.3.24.
Changes:
- Restructured
README.md(and added ES/ZH/PT translations) with a standardized layout, expanded sections, and new Support/Related/Community content. - Added a local QR generation script for the Support crypto addresses, plus
.gitignoreexceptions for committed poster/QR assets. - Updated
Cargo.lockto reflect1.3.24for the workspace crates.
Reviewed changes
Copilot reviewed 5 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src-tauri/Cargo.lock | Updates workspace crate versions to 1.3.24 in the lockfile. |
| scripts/generate-funding-qr.mjs | Adds a local QR generator + address validation for README funding QR images. |
| README.md | Restructures the main README to the ServerKit-style layout; adds Support/Related/Community sections and translation nav. |
| docs/README.es.md | Adds Spanish README translation aligned to the new structure. |
| docs/README.zh-CN.md | Adds Chinese README translation aligned to the new structure. |
| docs/README.pt.md | Adds Portuguese README translation aligned to the new structure. |
| .gitignore | Un-ignores the committed poster image and funding QR PNGs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+17
to
+20
| * Usage: | ||
| * npm i qrcode js-sha3 # not repo deps; install ad hoc when regenerating | ||
| * node scripts/generate-funding-qr.mjs | ||
| * node scripts/generate-funding-qr.mjs --check # verify committed PNGs match |
Comment on lines
+157
to
+160
| QRCode = require('qrcode'); | ||
| } catch { | ||
| console.error('\nMissing dep. Run: npm i qrcode js-sha3'); | ||
| process.exit(1); |
| Contributions are welcome! | ||
|
|
||
| ``` | ||
| fork → feature branch → commit → push → pull request |
| ¡Las contribuciones son bienvenidas! | ||
|
|
||
| ``` | ||
| fork → rama de feature → commit → push → pull request |
| Contribuições são bem-vindas! | ||
|
|
||
| ``` | ||
| fork → branch de feature → commit → push → pull request |
| 欢迎贡献！ | ||
|
|
||
| ``` | ||
| fork → 特性分支 → commit → push → pull request |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
README restructured to match the ServerKit family layout: poster hero, platform/downloads badges, language nav (ES/ZH/PT translations), 2-column screenshot tables, feature tables, 💛 Support section with crypto QR funding, Related Projects, Discord community section, standardized footer. Also includes the v1.3.24 crate bump.