Create an API documetation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- api, documentation
Research direction
Start by reviewing the API at https://tztools.gcp-npr.marigold.dev/api and compare its intended presentation with https://api.marigold.dev/. Inspect the repository entry points that expose the endpoints and determine how an automatically generated, interactive page could cover all of them. Done means the page documents every endpoint and lets users request the API from the page.
Written by the indexing model from the issue text.
Description
Create a page that describes all endpoints. It would be nice to use some tool that does this automatically.
It would be nice to be able to request the API using this page too.
Probably here: https://tztools.gcp-npr.marigold.dev/api
Example: https://api.marigold.dev/
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pingdotgg/t3code#14452 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
solana-foundation/program-examples#747 · 1 comment ·
Maintainers usually reply within 9 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
remotion-dev/remotion#11847 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openwatersio/slackwater#355 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
melgarafael/DeskcommCRM#1998 · 3 comments ·
Maintainers usually reply within 1 day