Conversation
This commit adds a caution block to the README file to raise awareness about potential restrictions on Android's open-source nature, including a link to the "Keep Android Open" initiative. - **docs**: Added a caution notice and link to `keepandroidopen.org` in `README.md`.
# Conflicts: # README.md
This commit performs a major update to the project's documentation, including a complete refresh of existing README files and the addition of several new localized versions. The documentation now features a more standardized structure, updated project statistics (e.g., 48k+ users, 5.5k+ stars), and detailed setup guides. - **docs**: Added new localized README files for Bengali (`README-BN.md`), Hindi (`README-HI.md`), Italian (`README-IT.md`), and Turkish (`README-TR.md`). - **docs**: Extensively updated and reformatted existing localized READMEs for French (`FR`), Polish (`PL`), Spanish (`ES`), Korean (`KR`), Russian (`RU`), Japanese (`JA`), and Chinese (`ZH`). - **docs**: Standardized documentation structure across all languages, including project overview, features, installation guides, legal notices, and GitHub OAuth configuration steps. - **docs**: Updated media links, badges, and social links (Discord, Website) across all documentation files. - **docs**: Added detailed security disclosures regarding APK signing certificates and legal disclaimers.
WalkthroughThis pull request adds four new localized README files (Bengali, Hindi, Italian, Turkish) and comprehensively updates six existing localized README files (Spanish, French, Japanese, Korean, Polish, Russian, Chinese). All changes are documentation-focused, updating project branding, structure, feature descriptions, OAuth setup guidance, and legal notices across multiple language variants. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/README-PL.md (1)
98-98: Optional: Minor accessibility and formatting improvementsAcross all localized READMEs, there are a few consistent minor formatting opportunities:
Heading structure (Line 98): The legal notice jumps from h1 to h3. Consider using h2 for better document hierarchy.
Code block language (Line ~396): The license code block is missing a language identifier. Add
textorplaintextafter the opening backticks.Image alt text: Consider adding descriptive alt text to images for better accessibility, especially the badge images.
These are minor improvements that can be addressed in a follow-up if desired.
💡 Example fixes
For heading structure (line 98):
-### 📋 Legal Notice +## 📋 Legal NoticeFor code block language (line ~396):
-``` +```text Copyright 2025 rainxchzed ...Also applies to: 396-396
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/README-PL.md` at line 98, Change the legal heading "### 📋 Informacja prawna" to an H2 ("## 📋 Informacja prawna") to restore proper heading hierarchy, add a language identifier like "text" or "plaintext" to the license code block (the triple-backtick block that contains the license text) so the fence reads ```text, and add descriptive alt text to any badge or inline images (replace empty alt attributes with short descriptions) to improve accessibility; locate these changes by searching for the exact heading string "📋 Informacja prawna", the license block contents, and existing image markdown for badges.docs/README-ES.md (2)
98-98: Fix heading level hierarchy.The heading jumps from h1 to h3, skipping h2. This affects document structure and accessibility for screen readers.
♻️ Proposed fix
-### 📋 Aviso Legal +## 📋 Aviso Legal🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/README-ES.md` at line 98, The "📋 Aviso Legal" heading currently uses an h3 and skips h2, breaking the document hierarchy; change the heading level for "📋 Aviso Legal" from h3 to h2 (i.e., use "## 📋 Aviso Legal") so the sequence follows the top-level h1 and restores proper heading order for accessibility and TOC generation.
3-3: Consider adding alt text to images for accessibility.Multiple images throughout the document lack descriptive alt text attributes, which impacts accessibility for users with screen readers. While some images have alt attributes set to empty strings or generic descriptions, providing meaningful descriptions would improve the user experience.
Examples:
- Line 3: App icon image
- Lines 23, 26, 29: Badge images (downloads, stars, users)
- Lines 74-79: Screenshot images
- Lines 116, 119: Download badge images
- Line 155: Preview GIF
Consider adding descriptive alt text for each image category, e.g.,
alt="GitHub Store app icon",alt="Download statistics badge",alt="Screenshot showing app features", etc.Also applies to: 23-23, 74-79, 116-116, 119-119, 155-155
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/README-ES.md` at line 3, The README images lack descriptive alt attributes; locate the <img> tags (e.g., src="../composeApp/src/commonMain/composeResources/drawable/app-icon.png" and the badge/screenshot/preview GIF <img> elements) and add meaningful alt text for each (e.g., alt="GitHub Store app icon", alt="Download statistics badge", alt="Screenshot showing app features", alt="Preview GIF of app usage"), avoiding empty or generic values so screen readers get useful descriptions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/README-ES.md`:
- Line 98: The "📋 Aviso Legal" heading currently uses an h3 and skips h2,
breaking the document hierarchy; change the heading level for "📋 Aviso Legal"
from h3 to h2 (i.e., use "## 📋 Aviso Legal") so the sequence follows the
top-level h1 and restores proper heading order for accessibility and TOC
generation.
- Line 3: The README images lack descriptive alt attributes; locate the <img>
tags (e.g.,
src="../composeApp/src/commonMain/composeResources/drawable/app-icon.png" and
the badge/screenshot/preview GIF <img> elements) and add meaningful alt text for
each (e.g., alt="GitHub Store app icon", alt="Download statistics badge",
alt="Screenshot showing app features", alt="Preview GIF of app usage"), avoiding
empty or generic values so screen readers get useful descriptions.
In `@docs/README-PL.md`:
- Line 98: Change the legal heading "### 📋 Informacja prawna" to an H2 ("## 📋
Informacja prawna") to restore proper heading hierarchy, add a language
identifier like "text" or "plaintext" to the license code block (the
triple-backtick block that contains the license text) so the fence reads
```text, and add descriptive alt text to any badge or inline images (replace
empty alt attributes with short descriptions) to improve accessibility; locate
these changes by searching for the exact heading string "📋 Informacja prawna",
the license block contents, and existing image markdown for badges.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
docs/README-BN.mddocs/README-ES.mddocs/README-FR.mddocs/README-HI.mddocs/README-IT.mddocs/README-JA.mddocs/README-KR.mddocs/README-PL.mddocs/README-RU.mddocs/README-TR.mddocs/README-ZH.md
1 participant
Summary by CodeRabbit
Documentation