digidem / digidem/comapeo-core-react-native
Update repo documentation
A pull request for this has already been merged.
- Dominant language
- Kotlin
- Stars
- 1
- Forks
- 0
- Avg merge
- 8h 24m
- Merged PRs (30d)
- 9
Description
Context
Milestone-doc nice-to-have: "Update documentation in repo."
The architecture and plan docs in docs/ have drifted as the build moved to Expo SDK 56 + rolldown, the map server was re-integrated, Sentry landed phases 3/6/7, and lifecycle/state handling was refactored. README.md, agents.md, and docs/ARCHITECTURE.md need a pass for accuracy before release.
Scope (to refine)
- README integration/setup steps current with the published package + Expo plugin.
-
docs/ARCHITECTURE.mdreflects current lifecycle/state machine and IPC topology. - Prune or mark stale plan docs (build-architecture-plan, runtime-alternatives) as historical.
- Cross-check doc references flagged stale in #53.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading README.md, agents.md, and docs/ARCHITECTURE.md, then inspect build-architecture-plan and runtime-alternatives in docs/. Cross-check the references flagged by issue #53 and the documented Expo SDK 56, rolldown, map server, Sentry, and lifecycle changes. Done means current docs are accurate and stale plan material is marked historical.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100