Documentation
Choose your path through guides, integration docs, system architecture, and research.
This docs app is organized by intent instead of repo sprawl. Start here if you need the quickest way to understand what the platform does, how to integrate with it, or where the deeper architecture and research material lives.
Start Here
Use the platform, call the API, or run the monorepo locally.
Guides
Member flows, wallets, account setup, and operator-facing walkthroughs.
Build
GraphQL, REST route families, local development, and deployment notes.
System
Current implementation state, scoring model, graph architecture, and network primitives.
Research
Scientific sources, repo archaeology, and the hidden material worth mining.
What Lives In This Docs Set
- Guides explains how people use the platform: onboarding, wallets, membership, and account operations.
- Build documents the integration surfaces: GraphQL, REST, local development, and deployment.
- System captures what is actually implemented now, not just what was once proposed.
- Research surfaces the papers, synthesis docs, planning material, and operational notes buried elsewhere in the repo.
Current Platform Baseline
- Runtime: Next.js 16, React 19, pnpm workspaces, and a monorepo split across app, api, docs, web, and shared packages.
- Core data layer: Neo4j stores members, personas, circles, graph relations, contribution state, and network metadata.
- Core protocol layer: Solana Token-2022 powers Florin, Joule, HoW, membership NFTs, and related on-chain state.
- Integration layer: GraphQL Yoga is the canonical application API, with task-oriented REST routes for Bridge, Fixie, Solana, documents, prices, and operations.
- Scoring model: CES-based contribution scoring with an HHI diversity bonus is now aligned across service logic and ranking cron jobs.
The highest-value repo material does not live only under apps/docs/content/docs. The new
Research Atlas and Repository Source Map point at
the synthesis docs, architecture trackers, and operational history that were previously hard to
discover.
Recommended Entry Points
- New to the project: go to Quickstart, then Docs Map.
- Integrating with the API: start with API Reference, then REST API Reference.
- Auditing the system: read Technical Overview and Architecture / Current State.
- Mining strategy and research: start with Research Atlas.