Skip to content

Docs: stale backend README test count + no mobile dev onboarding #164

Description

@Muawiya-contact

Problem
(a) backend/README.md:32 says “25 tests” but there are 84 test functions across 8 files, and line 30 lists api/v1/ as “health, topics, daily” while the code also ships me.py, concepts.py, pages.py (the endpoint table lower down is accurate — internal inconsistency).
(b) Mobile developer onboarding is essentially absent: mobile/AGENTS.md is 3 lines, mobile/DEPLOYMENT.md covers EAS/OTA but not local dev; there is no “clone → npm install → expo start” path and no mobile architecture/state overview (Context providers, services, mutation queue, offline model) — the most complex part of the codebase.

Impact — Erodes trust in the docs and undercounts coverage; a new dev can stand up the backend but has no on-ramp for the app beyond “read Expo docs.” (docs/ARCHITECTURE.md is a good high-level overview but stops at the boundary.)

Suggested direction — Fix the README numbers/endpoint list; add a short mobile/README.md (local run, env vars, folder map, offline/sync model).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority: lowPolish / nice to have

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions