API Documentation Detail
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
DB Design / Changes:
- db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
- db naming conventions
- buildQuery
Scraper:
- documentation on understanding wrangler.toml files, how scrapers work, what to expect from them
Endpoint:
- error codes and meanings GOOD PRACTICE - along with endpoint info.
- rest endpoint
- all files changed
- areas of focus, things to look out for
- what a typical change entails
- graphql
- difference between rest and graphql
- example of implementation
- where to test on docs page
Testing:- testing throughout the process [db change -> endpoint]
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by inventorying the requested documentation areas: database migrations and dumps, db naming conventions, buildQuery, wrangler.toml and the scraper script, REST and GraphQL endpoints, and testing. Review the existing docs site and docs page locations before writing. Done means the documented workflow covers database changes through endpoint testing, including error codes, examples, changed files, and areas to watch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql
- Domain
- api, databases, documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100