pearcord-docs

Documentation for Pearcord — a 100% peer-to-peer community chat app on Pear. No central message servers.

Current release: v0.8.235 (desktop app apps/pearcord).

---

Where to start

I want to…	Read
Run the app locally	GETTING_STARTED.md
Understand the system	ARCHITECTURE.md
Find a topic	DOCUMENTATION_INDEX.md
See all npm packages	MODULES.md
Track features / phases	PLATFORM_ROADMAP.md
Clone repos / push modules	GITEA_DEVELOPER.md
Run tests	AUTOMATED_TESTING.md
UI ↔ sidecar IPC	IPC.md

---

Repository layout

Path	Gitea repo
apps/pearcord/	pearcord
modules/pearcord-*/	one repo per module (64 packages)
docs/	pearcord-docs (this tree)
scripts/	pearcord-workspace

Workspace root /Users/raven/dev/pearcord has no single git root; each package commits independently.

---

Module documentation

Every pearcord-* package includes a full README in its own repo (modules/<name>/README.md): public API, P2P gossip, platform wiring, tests, and examples. MODULES.md maps each package to feature docs in this tree.

---

Contributing to docs

When you ship a feature:

1. Update PLATFORM_ROADMAP.md.
2. Add or refresh the feature doc (and DOCUMENTATION_INDEX.md if new file).
3. Update ARCHITECTURE.md only for cross-cutting changes.
4. Update the module README.md for API/gossip changes.

---

Stack

Hyperswarm · HyperDB · Protomux · Pear / Bare — see HOLEPUNCH_STACK.md.