Skip to main content

Developer Docs

Purpose

Developer docs explain how external developers, self-hosted operators, and partner agents integrate with VRDex or run it themselves.

Audience:

  • API consumers
  • self-hosted operators
  • partner-tool authors
  • external agents integrating with VRDex public data

What Belongs Here

  • public API shape and versioning
  • rate-limit and auth posture for public consumers
  • self-hosting setup expectations
  • deployment and provider variable names
  • portable skill and MCP integration guidance
  • stable route/schema examples for external tools

What Does Not Belong Here

  • private BASIC BIT credentials or project secrets
  • long product ideation notes
  • alternatives we considered but are not asking developers to act on
  • local agent workflow experiments unless they affect external integration

Current Entry Points

Files:

  • docs/developers/partner-agent-skill.md
  • docs/developers/opencode-skill-adapter.md
  • docs/developers/public-api.md
  • docs/developers/self-hosting-and-iac.md
  • docs/developers/vrdex-mcp-read-tools.md
  • docs/engineering/service-map.md
  • skills/vrdex/SKILL.md, compatibility pointer only

Deployment docs under docs/deployment/ also serve developers and operators today. Move or mirror them only when that improves clarity without creating duplicated maintenance.