Add documentation for API
Open
Nobody has claimed this yet.
p2: nice to have
status: for future
- Dominant language
- TypeScript
- Stars
- 40
- Forks
- 26
- Avg merge
- 49m
- Merged PRs (30d)
- 9
Description
Autogenerate options:
- Markdown: https://github.com/exogen/graphql-markdown (and then progress further with nuxt?)
- HTLM: https://github.com/2fd/graphdoc (seems to be dead)
- HTML: https://github.com/wayfair/dociql
- HTML: https://blog.graphqleditor.com/graphql-documentation-generator (needs online account)
- Write own generator based on graphql-code-generator https://www.graphql-code-generator.com/docs/custom-codegen/index
Contributor guide
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
Begin by comparing the listed GraphQL documentation generators: graphql-markdown, graphdoc, dociql, the GraphQL Editor generator, and graphql-code-generator custom codegen. Check each project's current status and whether it fits the API; completion would be a documented, selected approach for generating the API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100