Stu Mason
Stu Mason

Activity

Pull Request Merged

PR #21 merged: docs: Add API docs link to admin dashboard, improve API reference

Summary

  • Adds a "View API Documentation →" link in the API Keys section of the admin dashboard
  • Improves API reference documentation by replacing hardcoded localhost URLs with {base_url} placeholder
  • Expands authentication documentation with API key examples

Changes

Admin Dashboard

API Documentation (docs/api/overview.md)

  • Replaced all http://localhost:8000 with {base_url} placeholder
  • Added "Base URL" section explaining different environments (local, Docker, production)
  • Expanded "Authentication" section with:
    • API key authentication examples
    • Reference to Admin Dashboard for key management
    • Clearer separation of User ID and Sync endpoint requirements

Test plan

  • Verify link appears in API Keys section of admin dashboard
  • Verify link opens documentation in new tab
  • Review API documentation renders correctly on GitHub Pages
+521
additions
-42
deletions
14
files changed