Improve documentation / provide llms.txt file
- Dominant language
- TypeScript
- Stars
- 12k
- Forks
- 882
- PR merge metrics
- No merged PRs in 30d
Description
Hi, thank you for all your excellent APIs! They are great.
Unfortunately the documentation is a bit lacking. The interactive code builder is a bit buggy (the API request body doesn't change when you toggle the settings), and it's difficult to get a clear sense of the response payload body shape. Could you please provide clear documentation for the APIs, perhaps in the form of llms.txt, so that I can more easily integrate these systems?
Contributor guide
Research direction
Start by reviewing the interactive code builder and the current API documentation, focusing on the request-body toggle behavior and the response payload shapes. Done should include clearer API documentation and an llms.txt file, with the builder behavior addressed if it is within scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100