docs

Docs

• Contributing Guidelines

APIs

• Web API. Complete description of all endpoints.

Flows

• Registration Flow. User-registration and verification.
• Forgot Password Flow. User password reset.
• Dat Ownership Proof Flow. How ownership of a dat by a specific user is verified.

Components

• Jobs. Behaviors that either get triggered by a message, or auto-triggered by the scheduler.
• Triggers. Any file-indexing is handled by Triggers, which watch for changes to specific paths and archives, then queue jobs automatically when a change is detected.
• Locks. Locks are used internally to create regions of async code that will only be entered one at a time.

Schemas

• Access Scopes. The different permissions available to users.
• LevelDB. LevelDB layout and objects.
• Events. Events emitted by various components.