2022 Documentation Initiative Roadmap 🗺️
- Dominant language
- TypeScript
- Stars
- 16.9k
- Forks
- 1.9k
- Avg merge
- 22h 45m
- Merged PRs (30d)
- 70
Description
One of the most lamented flaws of this repository are the documentation
There are incredible options available for generating a docsite. So it needs to happen!
There might still be a branch from 2020
Service Layers to document:
- `graphiql` - getting started, advanced usage examples, FAQ, api docs,
- `monaco-graphql` - getting started, usage examples, simple advanced demos, demos for all bundlers, api docs
- `graphql-language-service-server` - getting started with an IDE plugin & graphql-config, settings table, graphql-config options table, example graphql-config configurations, example custom server implementations, FAQ, api docs
- `graphql-language-service-cli` - getting started, table of CLI options, point to server readme for `graphql-config`, reference, expected LSP client settings & most troubleshooting.
- `vscode-graphql` - getting started, how to use execute operation, point to server readme for `graphql-config`, reference, expected LSP client settings & most troubleshooting.
Ideas:
- generate typedoc markdown file API docs that we can link to statically in github from the readme, but then also consume for doc site SSG via gatsby, docusaurus, etc
- help build the mini-graphiql
Contributor guide
Assessment
This issue has not been assessed yet.