Choose a document by the task and its status. User guides describe supported operations; implementation references describe contracts and their limits; ADRs record why a decision was made. Proposals and historical designs are grouped separately below.

A document's original date and reviewed-version fields describe its baseline. Read its implementation or publication note before treating that baseline as the current release. A published feature does not by itself establish that every proposal or validation step in its design is complete.

Setup and everyday use

Task	Start here
Get started	What you need, then Start synchronising
Choose a CouchDB setup	Own server, Docker stack, Fly.io, or IBM Cloudant (managed)
Configure CouchDB clients	Quick setup
Find hosting services proposed by the community	Third-party hosting listings
Set up S3-compatible storage	Object Storage Setup
Set up peer-to-peer synchronisation	P2P communication model, then Peer-to-Peer Setup
Diagnose P2P connectivity	Browser-assisted check, network tips, and self-hosted TURN
Understand a setting or command	Settings reference
Read or customise synchronisation status	Status indicators and CSS snippets
Investigate or recover from a problem	Troubleshooting, then the relevant recovery procedure
Prepare an issue report	Issue reporting

The project overview links to Japanese and Chinese documentation.

Implementation and technical references

Use these references for the area being changed, together with its relevant ADR. Check the document's stated scope and validation limits before relying on a guarantee.

Area	References
Overall synchronisation and terminology	Technical overview, glossary, and terminology conventions
Metadata, Chunks, and database representations	Data structures
Conflict resolution, provenance, and history restoration	Conflict and provenance contract, Document History restoration, and local save completion
Replicator and host boundaries	Replicator architecture snapshot and service feature and legacy Module boundaries
Chunk retrieval and maintenance	Chunk retrieval and waiting, Garbage Collection V3, and Data Compression
Document identity and validation	Unicode path identity, configurable ID derivation, Metadata ID validation and repair, and path component compatibility
Settings compatibility and profiles	Tweak compatibility and recovery and remote configuration management
Encryption and sharing	Metadata encryption and time-bound Setup URIs
P2P connection preparation	TURN connection settings
Journal storage internals	Journal Replicator 2nd Edition

The installed @vrtmrz/livesync-commonlib package is authoritative for shared runtime contracts. Use the exact dependency selected by package.json and its lockfile when checking behaviour. The Commonlib documentation is maintained in that repository; this index does not replace its package contracts.

Architectural decisions

Read the decisions relevant to the change, rather than treating the whole ADR directory as a prerequisite. A decision's acceptance, its implementation, its release, and its remaining verification work are separate facts.

Decision area	Records
Shared package boundary	Common library package boundary
Replicator capabilities and migration	Core contract, P2P service lifecycle, and migration plan
Remote resources and Fast Setup	CouchDB connection ownership, Fast Fetch eligibility, and persistence and completion
P2P lifecycle and setup	Transport lifecycle, connection check, profile-aware onboarding, and compatibility controls
Settings interface integration	Declarative settings adapter
Saving and path identity	Local file save completion and batching and Unicode path identity
Activity and Chunk arrival	Bounded remote activity and Chunk arrival quiescence
Compatibility and validation	Release notes and database compatibility gates and real Obsidian E2E

Proposals and incomplete explanations

These records are useful for design work. Their proposed representation or behaviour is not a current runtime contract.

Document	Recorded state
Tiered Chunk Storage with Live Compaction	In design
Tiered Chunk Storage for Bucket Sync	In design
Design intent for Metadata and Chunks	Incomplete explanation; use the data-structure reference for current representations
Feature maturity for 1.0	Proposed; publication of 1.0 alone does not establish formal acceptance of this record

Historical and retired designs

These documents preserve earlier motivations, approaches, or results. Follow their maintained replacement for current operations.

Historical material	Current starting point
Original Tweak-sharing proposal	Tweak compatibility and recovery
First Journal Sync design	Journal Replicator 2nd Edition
Eden design and operational results	The document records its deprecated, frozen status; use Data structures for representations still accepted by current code
Withdrawn Chunk Aggregation by Prefix	Retained as a withdrawn proposal, not an implemented storage layout

Dated measurements, including the Data Compression benchmark, remain evidence for their recorded revision and environment. A current rerun is a separate measurement.

Development, validation, and release history

Development guide: build, module ownership, and release workflow.
Contributing: contribution and documentation checks.
Independent applications: CLI, WebApp, and WebPeer.
Setup utilities: provisioning and Setup URI generation.
Review Harness: bounded real-device observations and performance measurements.
Test procedures: choose the suite which owns the boundary being changed.
Change notes: current release and unreleased changes.
Published release archives: 1.0, 1.0 previews, 0.25, and earlier releases.

When a feature ships or a design is replaced, update its implementation note and this index if its role changes. Preserve the original decision and measurement history, state the maintained replacement, and keep existing links working.