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.

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

Create a Docusaurus2 instance for developer documentation in this repo with interactive OpenAPI documentation #28

Open
mikepsinn opened this issue Mar 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers important & urgent Important tasks HAVE to be done.

Comments

@mikepsinn
Copy link
Contributor

We need to create a Docusaurus2 instance for our developer documentation in this repository. The documentation should include detailed instructions on how to use our APIs, SDKs, and other developer tools.

User Story

As a developer who is new to our API, I want to be able to quickly and easily find the information I need to get started. This includes detailed documentation on each endpoint, example code snippets in various programming languages, and interactive OpenAPI documentation that I can use to explore and test the API.

Requirements

The Docusaurus2 instance should be set up with the following features:

  • A clean and easy-to-navigate design that's optimized for developer documentation
  • Interactive OpenAPI documentation that's automatically generated and updated from our API specs
  • Clear and concise instructions on how to use our APIs, SDKs, and other developer tools
  • Code snippets and examples that illustrate how to use our APIs and SDKs
  • A search function that allows developers to quickly find the information they need

Existing Work

Suggested Libraries

How You Can Help

  • Please ask any questions you can think of in the comments
  • Propose a framework or suggest implementation details
  • Help us prioritize this issue by reacting with 👍or 👎
  • Create a Gitcoin campaign to fund this issue
  • Assign it to yourself and do it
@mikepsinn mikepsinn added documentation Improvements or additions to documentation not important & not urgent Tasks that are urgent have a fast-approaching deadline. important & urgent Important tasks HAVE to be done. good first issue Good for newcomers and removed not important & not urgent Tasks that are urgent have a fast-approaching deadline. labels Mar 21, 2023
@mikepsinn mikepsinn pinned this issue Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers important & urgent Important tasks HAVE to be done.
Projects
None yet
Development

No branches or pull requests

1 participant