Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create Developer Docs #8588

Open
aarushik93 opened this issue Nov 8, 2024 — with Linear · 2 comments
Open

Create Developer Docs #8588

aarushik93 opened this issue Nov 8, 2024 — with Linear · 2 comments

Comments

@aarushik93 Linear
Copy link
Contributor

Once a clean API is available - create documentation
@fromancient
Copy link

Suggestion: Create Comprehensive Developer Documentation for API

Proposed Structure

  • Introduction: Brief overview of API capabilities.
  • Getting Started: Instructions to authenticate and access the API.
  • Endpoints Overview: Detailed documentation of all API endpoints.
  • Rate Limiting: Explanation of usage limits.
  • FAQs: Common questions with clear answers.
  • Support Contact: How to reach support for additional help.

@khongminhtn
Copy link

Diagramming of the overall platform architecture would come in handy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@aarushik93 @fromancient @khongminhtn