Skip to content

AGENTS.md

Latest commit

 

History

History
39 lines (29 loc) · 1.31 KB

AGENTS.md

File metadata and controls

39 lines (29 loc) · 1.31 KB
Raw

Documentation project instructions

About this project

  • Sprinter API documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run mint dev to preview locally
  • Run mint broken-links to check links

Repos documented

Repo Type Spec
sprintertech/sprinter-api REST API (Go/Gin) OpenAPI 3.0 at api-reference/sprinter/openapi.json

Terminology

  • "credit" — collateralized borrowing via CreditHub contracts
  • "solver" — entity that fills cross-chain intents
  • "earn vault" — yield-bearing wrapper (Morpho, Yo Protocol)
  • CAIP-2 format for chain IDs: eip155:8453 (Base), eip155:1 (Ethereum)
  • "MPC signing" — threshold signature scheme across multiple nodes

Style preferences

  • LLM/agent-optimized: prioritize code snippets, types, and structured tables over prose
  • Curl examples for every endpoint
  • Go type definitions from source code
  • JSON request/response examples
  • Minimal explanatory text — let code speak
  • Use tables for parameters, enums, and config
  • Use active voice and second person ("you")

Content boundaries

  • Do not document internal deployment/ops procedures
  • Do not document environment variables or secrets
  • Focus on external-facing API contracts only