Skip to content

Docs/add documentation tabs#6

Open
parul-2718 wants to merge 21 commits intomainfrom
docs/add-documentation-tabs
Open

Docs/add documentation tabs#6
parul-2718 wants to merge 21 commits intomainfrom
docs/add-documentation-tabs

Conversation

@parul-2718
Copy link
Copy Markdown
Collaborator

This is the main documentation migration and expansion branch. It covers three things:

  1. Migration all existing Kleros documentation from GitBook ported to Mintlify MDX
  2. New V2 developer docs written from scratch for Kleros V2 (Neo) on Arbitrum One
  3. Structure three-tab navigation (Documentation / Developers / Reference) with
    full coverage of court mechanics, products, integrations, and contract reference

What's included

Documentation tab (user-facing)

  • Kleros Court: overview, how it works, court hierarchy, appeals, architecture
  • Products: Curate, Stake Curate, Escrow, Governor, Scout, Reality, Proof of Humanity, Foresight
  • Concepts: dispute resolution, game theory, sortition, tokenomics, credible neutrality
  • Research: papers, case studies, partnerships
  • Governance: overview, KIPs, Snapshot
  • Enterprise: enterprise use cases, ecosystem
  • Community: Escrowly, Lockler, KlerosBoard
  • Legacy (V1): full V1 integration docs, retired products (Linguo, Tokens, Moderate)

Developers tab (integration guides)

  • Getting Started: quickstart, architecture, overview
  • Building Arbitrable Apps (V2): overview, implementation guide, testing, production checklist
  • Building on Kleros Products: Curate V2, Escrow V2, Proof of Humanity V2, Reality V2
  • Cross-chain: Vea bridge architecture, getting started, deployment addresses, L2 integration
  • Examples: escrow contract, insurance claim, DAO governance
  • Subgraph & Data: overview, endpoints, queries
  • V1 Legacy: ERC-792, ERC-1497, arbitrable proxy, light curate, classic curate, migration guide

Reference tab

  • Contracts: KlerosCore, DisputeKit, SortitionModule, Gateways, Governor, PolicyRegistry,
    DisputeTemplateRegistry, ModeratedEvidence, deployment addresses
  • Data Formats: dispute templates, evidence format, policy format, court specification,
    cross-chain evidence
  • Architecture: V2 architecture, arbitrator spec, sortition spec, Vea bridge overview
  • SDK: @kleros/kleros-sdk reference

Other

  • Mintlify navigation configured with tabs, anchors, dropdowns, and footer links
  • Hero images, Mermaid diagrams replacing ASCII art
  • Styling (style.css)
  • Futarchy documentation under Products

Parul and others added 20 commits January 29, 2026 17:11
- Add comprehensive Escrow V2 docs: overview, smart contracts, integration
- Add comprehensive Curate V2 docs: overview, smart contracts, integration
- Update navigation to show nested page structure
New pages:
- Products: governor, scout, reality, proof-of-humanity
- Concepts: dispute-resolution, game-theory, sortition, tokenomics, credible-neutrality
- Research: overview, papers, case-studies, partnerships
- Governance: overview, kips, snapshot
- Legacy: overview, migration-guide, court-v1, curate-v1, escrow-v1, governor-v1, resolver-v1
- Retired: moderate, linguo, tokens

Updated docs.json navigation for all new pages.
- Products: PoH V2, Reality Oracle (overview, smart contracts, integration)
- Products overview landing page
- Cross-chain: Vea Bridge, L2 Integration guide
- Examples: Escrow contract, Insurance claim, DAO governance
- Legacy: V1 overview, ERC-792, ERC-1497, V1 arbitrable apps, V1→V2 migration
- Updated docs.json navigation
- Applied accuracy fixes to existing docs
…sputeKit, Sortition, Gateways, Governor,

  PolicyRegistry, TemplateRegistry, ModeratedEvidence, deployment addresses),
  Data Formats (dispute templates, evidence, policy, court spec, cross-chain evidence),
  Architecture (V2 architecture, arbitrator spec, sortition spec, Vea bridge), SDK
- Documentation tab: Kleros FAQ, Community & Ecosystem (Escrowly, Lockler, KlerosBoard), Stake Curate product page,
  V2 Deep Dive (architecture, dispute lifecycle, commit-reveal/Shutter)
@parul-2718 parul-2718 requested a review from jaybuidl April 6, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants