Feature: Add public API documentation site and developer portal

[Calebux]

Description

SYNCRO's SDK and webhook system require external developers to understand the API. Currently there is no public documentation. A developer portal would enable third-party integrations, accelerate SDK adoption, and serve as a reference for the SYNCRO team itself.

Feature Scope

Documentation Site

Use Mintlify or Docusaurus to create a documentation site at docs.syncro.app:

Sections

Getting Started

• What is SYNCRO?
• Quickstart: add your first subscription via API in 5 minutes
• Authentication (Bearer token, API keys)
• Base URL and environments

API Reference

• Auto-generated from OpenAPI spec (once Swagger is added — see related issue)
• Interactive: try API calls directly from docs
• Code examples in TypeScript, Python, cURL

SDK Reference

import { SyncroSDK } from '@syncro/sdk';

const syncro = new SyncroSDK({
  apiKey: 'sk_your_api_key',
  baseUrl: 'https://api.syncro.app',
});

const subscription = await syncro.createSubscription({
  name: 'Netflix',
  price: 17.99,
  currency: 'USD',
  billingCycle: 'monthly',
  nextRenewalDate: '2025-04-15',
});

Webhooks Guide

• Event types reference
• How to verify webhook signatures
• Sample code for handling each event type

Soroban Contract Reference

• Contract addresses (testnet, mainnet)
• Function signatures and parameters
• Event types emitted
• How to verify subscription data on-chain

Guides

• "Track subscriptions for your team"
• "Build a subscription tracker with SYNCRO SDK"
• "Verify subscription data on Stellar Explorer"

Developer Portal Features

• API key management (see related issue)
• Webhook testing console
• API request logs (last 100 requests)
• Sandbox environment

Implementation

# Using Mintlify
npm install -g mintlify
mintlify init  # creates docs/ directory

Acceptance Criteria

• Docs site deployed at docs.syncro.app
• Quickstart guide (under 5 minutes to first API call)
• Complete API reference generated from OpenAPI spec
• SDK reference with code examples
• Webhook guide with signature verification examples
• Soroban contract reference with testnet addresses

[drips-wave]

This issue has been added to the Stellar Wave Program and is worth 150 Points.

🧑‍💻 Interested in contributing? Apply to work on this issue on Drips Wave, earn points, and receive rewards.

Warning

Only applications submitted via the apply link above will be considered. Please do not apply by commenting on the issue or opening a PR directly.

🤠 Repo maintainers: You can manage this issue's Points and Complexity on your Maintainer Dashboard here. Please keep an eye on applications and respond quickly 💙

ℹ️ Learn more about Drips Wave

[devAgatha]

@devAgatha has applied to work on this issue as part of the Stellar Wave Program's 3rd wave.

Hi maintainer. I can work on this issue, please assign.

Thank you!

ℹ️ Repo Maintainers: To accept this application, review their application or assign @devAgatha to this issue.

[Xaxxoo]

@Xaxxoo has applied to work on this issue as part of the Stellar Wave Program's 3rd wave.

Hi can I take up on this issue?

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Xaxxoo to this issue.

[drips-wave]

Congratulations, @Xaxxoo! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on March 30, 2026.

🧑‍💻 @Xaxxoo: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊