Skip to content

docs: completa il README (download, registrazione/recupero, setup server) - #7

Merged
fabiodalez-dev merged 1 commit into
mainfrom
docs/readme-complete
Jun 25, 2026
Merged

docs: completa il README (download, registrazione/recupero, setup server)#7
fabiodalez-dev merged 1 commit into
mainfrom
docs/readme-complete

Conversation

@fabiodalez-dev

@fabiodalez-devfabiodalez-dev commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Il README aveva il link di Download morto (v1.0.0 / nome file vecchio), non citava registrazione e recupero password, e mancava il lato server. Completato: download alla pagina Releases latest + nome asset corretto, riga auth con registrazione/recupero, nuova sezione "Enable the Mobile API on the server" con link alla doc, link intro al repo principale.

Summary by CodeRabbit

  • Documentazione
    • Aggiornata l’introduzione per descrivere l’app Android come client nativo per una specifica istanza di Pinakes.
    • Riviste le istruzioni di download e installazione con riferimenti più chiari alla release più recente e al sideload.
    • Aggiornata la sezione delle funzionalità con il supporto a accesso e registrazione, inclusi recupero password.
    • Aggiunte indicazioni per abilitare l’accesso mobile sul server e verificare gli endpoint di salute e documentazione.

…tup)
- Download pointed to a dead v1.0.0 asset (pinakes-debug.apk) — now links to the
Releases "latest" page with the current asset name + sideload note
- Features: the auth row now mentions in-app registration and password recovery
- New "Enable the Mobile API on the server" subsection (activate the plugin +
enable mobile app access) with a link to the docs
- Fix the intro link to point at the main Pinakes repo
@fabiodalez-dev
fabiodalez-dev merged commit 63a9bd4 into mainJun 25, 2026
@fabiodalez-dev
fabiodalez-dev deleted the docs/readme-complete branch June 25, 2026 19:30
@coderabbitai

coderabbitaiBot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 560f61bb-8409-43b9-8e04-2303a142c91a

📥 Commits

Reviewing files that changed from the base of the PR and between e68fac3 and b38acf8.

📒 Files selected for processing (1)
  • README.md

Walkthrough

Il README aggiorna la descrizione dell’app, le istruzioni di installazione, la voce delle funzionalità di autenticazione e aggiunge una sezione per abilitare la Mobile API e l’accesso mobile sul server.

Changes

README onboarding and server setup

Layer / File(s)Summary
Client overview and install
README.md
L’introduzione descrive l’app come client Android nativo per una istanza specifica di Pinakes; la sezione download usa la release latest e la riga delle feature passa a “Sign in & sign up”.
Mobile API server setup
README.md
Viene aggiunta una sezione che documenta l’attivazione della Mobile API sul server, il mobile app access e la verifica degli endpoint /api/v1/health e /api/v1/docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Hop hop, nel README ho fatto capolino,
tra latest release e API ho trovato il mio cammino.
Sign in, sign up: tutto più chiaro al mattino,
e il server sussurra “mobile access” dal suo giardino.
Con un APK ben firmato, salto via contentino!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-complete

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.

Sign up for freeto 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

@fabiodalez-dev