Home

GitNotēs Wiki

Project knowledge base for contributors and AI agents. All pages are automatically synced to the GitHub Wiki on every merge to main.

Pages

Page	Description
Setup	Prerequisites, install, run, environment variables
Architecture	Full tech stack, key modules, data flow, navigation
Development Guide	Dev commands, troubleshooting, contributing
Services	Every service file with one-line purpose, grouped by domain
Stores	Every Zustand store with state shape and key actions
Screens & Navigation	All screens, navigation tree, deep link paths
Hooks	Every custom hook catalogued with purpose
Models	Every TypeScript model interface with key fields
Contexts	Every React context with provider hierarchy
Sync Architecture	Clone sync deep-dive
Git Engine	Rust native Git module architecture and build process
Paywall & Pro Tier	RevenueCat, StoreKit 2, entitlements, feature gates
Note File Format	How notes are stored on disk — frontmatter, file format, DocumentIndex, wiki-links

Quick Start

yarn install
yarn start     # Metro bundler
yarn ios       # iOS
yarn android   # Android

AI Agent Note

If you are an AI agent modifying code in this repository, read the Architecture page before making significant changes. Any change to services, stores, screens, hooks, models, contexts, sync, or the Git engine must update the corresponding wiki page. See AGENTS.md for the full wiki-first rule.

Documentation Philosophy

• For contributors: docs/wiki/ is the source of truth; CHANGELOG.md records individual fixes.
• For AI agents: Every module, service, store, and model is documented here with precise names and paths.
• Wiki sync: Edit docs/wiki/*.md and open a PR. The CI workflow (.github/workflows/sync-wiki.yml) mirrors changes to the GitHub Wiki automatically.

See Also

• GitHub Wiki
• CHANGELOG.md
• AGENTS.md