Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 829 Bytes

File metadata and controls

30 lines (21 loc) · 829 Bytes

Documentation — TODO

See root TODO for overview.

Content

  • Examples page (cURL, JavaScript, Python)
  • docs.mosque.api as canonical URL
  • Expand Getting Started: rate limits
  • Add guides: Webhooks, Ramadan endpoints, Search filters
  • Add Postman/Insomnia collection export
  • Changelog / versioning for API versions

OpenAPI

  • Complete OpenAPI spec for all endpoints (paths + request/response schemas)
  • Add example request/response bodies
  • Serve spec from docs app as static fallback when API is not available

UX & SEO

  • Sidebar nav for doc sections
  • Mobile-friendly layout
  • Canonical URLs and meta per page
  • Sitemap for /docs/*

Integration

  • Link to resources (guides, use cases) on mosque.api
  • Consistent nav with landing page