docs: complete README with screenshots and APK download - #1
Conversation
Warning Review limit reached
More reviews will be available in 9 minutes and 29 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. WalkthroughIl file ModificheRiscrittura README.md
Stima dello sforzo di revisione🎯 1 (Trivial) | ⏱️ ~4 minuti Poesia
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 32-45: The image tags in the screenshot table are missing the
`alt` attribute, which causes accessibility and markdownlint errors. Add a
descriptive `alt` attribute to each `<img>` tag in the table. For each image
(login.png, home.png, catalog.png, detail.png, calendar.png, library.png,
profile.png), use the corresponding sub-label text as the alt text to provide
meaningful descriptions for screen readers and improve accessibility compliance.
- Line 99: The relative path `../../releases` in the root README.md file
incorrectly points above the repository structure and will break. Replace the
link path with either a correct relative path from the root directory (such as
`releases` or `/releases`) or use the absolute GitHub repository URL pointing to
the releases page. This ensures the link works correctly regardless of where the
file is accessed from.
- Around line 14-16: The Download section heading uses an incorrect level (###)
that is inconsistent with the rest of the document structure - change it to ##
to match other major sections. Additionally, the text references "latest
release" but the download link is hardcoded to the specific version
v1.0.0-debug, creating a mismatch. Either update the link to point to
releases/latest for dynamic behavior, or explicitly state v1.0.0-debug in the
text to match the hardcoded link. Choose the approach based on whether you want
the documentation to automatically reflect new releases or maintain a specific
version reference.
- Around line 133-148: The fenced code block containing the directory tree
structure starting with app/src/main/java/com/pinakes/app/ is missing a language
declaration after the opening backticks, which causes linting errors. Add a
language identifier such as text or plaintext after the triple backticks at the
start of the block (change ``` to ```text or ```plaintext) to properly declare
the code block format and resolve the lint warning.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3faa06bc-e745-4f80-90b8-16e621f3681a
⛔ Files ignored due to path filters (7)
docs/screenshots/calendar.pngis excluded by!**/*.pngdocs/screenshots/catalog.pngis excluded by!**/*.pngdocs/screenshots/detail.pngis excluded by!**/*.pngdocs/screenshots/home.pngis excluded by!**/*.pngdocs/screenshots/library.pngis excluded by!**/*.pngdocs/screenshots/login.pngis excluded by!**/*.pngdocs/screenshots/profile.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| Launch → enter your instance URL on the onboarding screen → sign in. The library must have | ||
| **mobile app access enabled**. For local dev the API is on `http://<lan-ip>:8081` (emulator: | ||
| `http://10.0.2.2:8081`). HTTPS is required for non-loopback hosts. | ||
| A prebuilt debug APK is published on the [Releases](../../releases) page. |
There was a problem hiding this comment.
Correggi il link alle Releases.
Da README.md in root, ../../releases risale sopra la repository e rischia di rompersi. Usa un link relativo corretto (releases / /releases) o l’URL assoluto di GitHub.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 99, The relative path `../../releases` in the root
README.md file incorrectly points above the repository structure and will break.
Replace the link path with either a correct relative path from the root
directory (such as `releases` or `/releases`) or use the absolute GitHub
repository URL pointing to the releases page. This ensures the link works
correctly regardless of where the file is accessed from.
| ``` | ||
| app/src/main/java/com/pinakes/app/ | ||
| ├── data/ # models, network (Retrofit API + envelope handling), repositories, secure session store | ||
| ├── di/ # ServiceLocator (manual DI) | ||
| ├── data/ | ||
| │ ├── model/ kotlinx.serialization models (mirror the live /api/v1 JSON) | ||
| │ ├── network/ PinakesApi (Retrofit) + interceptors | ||
| │ ├── repository/ Auth / Catalog / Library / Profile / Notifications | ||
| │ └── store/ SessionStore, FeatureStore, ThemeStore (EncryptedSharedPreferences) | ||
| ├── di/ ServiceLocator | ||
| └── ui/ | ||
| ├── theme/ # Material 3 colour schemes, Inter typography, shapes, spacing | ||
| ├── components/ # design system: BookCard, AvailabilityChip, buttons, text fields, states, rows… | ||
| ├── common/ # UiState, date formatting, status mapping, LocalServices | ||
| ├── navigation/ # NavHost, bottom-nav scaffold, route keys | ||
| └── screens/ # onboarding, login, search, detail, library, wishlist, profile, notifications, contact | ||
| ├── theme/ Color / Type / Theme (magenta #D70161 brand, light default) | ||
| ├── components/ BookCard, AvailabilityChip, AudioPlayer, bottom bar … | ||
| ├── navigation/ NavHost + scaffold | ||
| └── screens/ onboarding, login, home, search, detail, library, wishlist, profile … | ||
| i18n/ en/it/fr/de.json (source of truth for strings) | ||
| _contract/ OpenAPI snapshot + API spec the app is built against | ||
| ``` |
There was a problem hiding this comment.
Specifica il linguaggio del fenced block.
Il blocco con l’albero delle directory non dichiara un linguaggio, quindi il lint lo segnala. text o plaintext è sufficiente.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 133-133: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 133 - 148, The fenced code block containing the
directory tree structure starting with app/src/main/java/com/pinakes/app/ is
missing a language declaration after the opening backticks, which causes linting
errors. Add a language identifier such as text or plaintext after the triple
backticks at the start of the block (change ``` to ```text or ```plaintext) to
properly declare the code block format and resolve the lint warning.
Source: Linters/SAST tools
- Download heading promoted to ## (was ### — heading-increment MD001) - pin the wording to release v1.0.0-debug to match the hardcoded link - add alt text to all 7 screenshot images (MD045, accessibility)
Rewrites the README into a complete project page and links it to the installable build.
What's in here
docs/screenshots/(login, home, catalog + filters, book detail, availability calendar, my library, profile).The debug APK is published as a GitHub Release asset (not committed, since it's a build artifact).
Summary by CodeRabbit