Skip to content

Critical documentation not accessible from main site #15

@crtahlin

Description

@crtahlin

Problem

Key documentation needed to use the platform is only available in the GitHub README, not on the main site. Users browsing agents.datafund.io cannot easily find:

  • Complete API reference
  • Purchase flow explanation
  • CLI commands (`sx` tool)
  • Environment variables
  • Reputation system details
  • Architecture overview

What's on GitHub (but not the site):

  1. Transaction flow diagram - Critical for understanding buyer/seller interaction
  2. API endpoint table - 15+ endpoints with descriptions
  3. Reputation tiers - Score ranges and recommendations
  4. sx CLI reference - Primary tool for agents
  5. Network/contract addresses - Needed for direct integration

What's on the site:

  • Landing page with value proposition
  • Skills/Bounties/Agents browsing
  • SKILL.md at /skill.md (but not linked prominently)

Impact

  • Users don't know how to complete purchases
  • Developers can't find API docs
  • `purchase-info` endpoint (critical for buying) not documented in UI
  • Creates support burden as users ask basic questions

Expected Behavior

Main site should have:

  1. Prominent "Docs" link in navigation
  2. Getting Started guide for buyers
  3. Getting Started guide for sellers
  4. API reference (or link to it)
  5. FAQ addressing common issues

Suggested Implementation

Option A: Add /docs page to the site

  • Render README.md content
  • Add buyer/seller quick-start guides

Option B: Prominent link to GitHub docs

  • Add "Documentation" to nav
  • Deep link to relevant sections

Option C: Inline documentation

  • Add help tooltips/modals in the UI
  • "How to buy" explanation on skill detail page

Acceptance Criteria

  • Documentation accessible from main navigation
  • Purchase flow clearly explained
  • API endpoints listed with examples
  • New users can self-serve without GitHub

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2-mediumMedium: Developer experience issuesdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions