Skip to content

Comments

docs: comprehensive protocol documentation overhaul#349

Merged
Yunusabdul38 merged 3 commits intoWeb3Novalabs:mainfrom
zintarh:docs/issue-336-redesign
Feb 21, 2026
Merged

docs: comprehensive protocol documentation overhaul#349
Yunusabdul38 merged 3 commits intoWeb3Novalabs:mainfrom
zintarh:docs/issue-336-redesign

Conversation

@zintarh
Copy link
Contributor

@zintarh zintarh commented Feb 21, 2026

Overview

This PR transforms the PrediFi documentation into a world-class developer resource, moving away from "dry" technical lists and adopting a "Developer First" style inspired by Polymarket and Stripe.

Changes

New Documentation Files

  1. docs/quickstart.md - 5-minute guide to make your first prediction

    • Step-by-step wallet connection
    • Copy-pasteable code snippets
    • Complete working examples
  2. docs/prediction-lifecycle.md - Complete lifecycle documentation

    • Four-phase lifecycle (Creation → Trading → Resolution → Settlement)
    • Mermaid diagrams for visual flows
    • State transition diagrams
    • Incentive alignment explanation
  3. docs/oracles.md - Verifiable Oracle documentation

    • Stork Network integration details
    • Oracle resolution flow
    • Verification methods
    • Security considerations
  4. docs/contract-reference.md - Complete API reference

    • All contract methods with parameters
    • Data structures
    • Events schemas
    • Error codes reference
  5. docs/troubleshooting.md - Comprehensive error handling guide

    • Complete error code reference
    • Common errors with solutions
    • RPC & network issues
    • Debugging tips

Features

  • Developer-First Style: Clear, actionable content with working code examples
  • Visual Diagrams: Mermaid.js diagrams for lifecycle, resolution, and incentive flows
  • Professional Callouts: Tip, info, and warning callouts throughout
  • Complete API Reference: All contract methods documented with examples
  • Error Handling: Comprehensive troubleshooting guide with error codes

Style Improvements

  • Confident, clear, and technical but accessible tone
  • Structure: Quickstart → Core Concepts → API Reference → Tutorials
  • No fluff - every sentence provides value to developers
  • Professional Markdown formatting with tables and code blocks

closes #336

@vercel
Copy link

vercel bot commented Feb 21, 2026

@zintarh is attempting to deploy a commit to the shola's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Collaborator

@Yunusabdul38 Yunusabdul38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Yunusabdul38 Yunusabdul38 merged commit cab0f50 into Web3Novalabs:main Feb 21, 2026
1 of 2 checks passed
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.

Generate Technical API Documentation from Source

2 participants