Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Finish documentation #1024

Open
7 of 19 tasks
jasonkuhrt opened this issue Aug 7, 2024 · 0 comments
Open
7 of 19 tasks

Finish documentation #1024

jasonkuhrt opened this issue Aug 7, 2024 · 0 comments
Labels
type/docs
Milestone
8

Comments

@jasonkuhrt
Copy link
Member

jasonkuhrt commented Aug 7, 2024 •
edited
Loading

This issue will track a check list of work to do for Graffle documentation.

  • website tech
  • Introduction
  • examples in website via script chore(docs): add generated examples to website #1040
  • CLI
  • output
  • meta examples content: where the server is, where the source code is, etc.
  • schema errors
  • graphql feature mappings
  • transiton from static to generated
  • http transport
    • request timeout +example
    • get method +example
  • in the examples page put a subpage that has the pokemon graphql schema (SDL)
  • appendix
    • platform support (last two versions of LTS node)
    • contribution
  • fully describe all types and fields in pokemon schema so that JSDoc generation is fully exemplified
  • migration guide from graphql-request e.g. "Not sure how to migrate the return type of our existing createClient(): GraphQLClient signature." from Very early v8 feedback #1152
  • guide: custom scalars
@jasonkuhrt jasonkuhrt pinned this issue Aug 7, 2024
@jasonkuhrt jasonkuhrt mentioned this issue Aug 23, 2024
Open
15 tasks
@jasonkuhrt jasonkuhrt added this to the 8 milestone Sep 10, 2024
@jasonkuhrt jasonkuhrt unpinned this issue Sep 27, 2024
@jasonkuhrt jasonkuhrt changed the title Finish Graffle documentation Finish documentation Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/docs
Projects
None yet
Milestone
8
Development

No branches or pull requests
1 participant
@jasonkuhrt