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.

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

chore(docs): add graphql docs generation #1594

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Conversation

hiemanshu
Copy link
Contributor

Description

Uses spectaql to generate graphql docs. requires a global install of spectaql

Motivation and Context

Provides a clean looking (and public facing possibly) interface for GraphQL API Docs.

How Has This Been Tested?

Screenshots (if appropriate):

Screenshot 2023-05-02 at 5 08 31 PM

Screenshot 2023-05-02 at 5 08 46 PM

Screenshot 2023-05-02 at 5 08 54 PM

Documentation Changes

Checklist:

  • My change requires a change to the documentation.
  • I have included updates for the documentation accordingly.

uses spectaql to generate graphql docs. requires a global install of spectaql
@hiemanshu hiemanshu self-assigned this May 2, 2023
@hiemanshu hiemanshu removed the request for review from bchrobot May 2, 2023 11:40
@lediur
Copy link
Contributor

lediur commented May 2, 2023

What does adding descriptions / examples to the schema look like? Would that get merged in by codegen from the individual schemas?

I would love to see a worked example in this PR with some explanations / examples so we know a little bit about how much work it takes to enhance the generated documentation with developer commentary.

@bchrobot
Copy link
Member

bchrobot commented May 3, 2023

I second what Derrick asked above.

I think we should also be explicit about who the intended audience is for these docs, how they'll use it, and how the GraphQL documentation might connect or relate to other documentation (user docs, docs of the REST endpoints, schema docs, etc.). Regardless, I would rather see this as a local dev dependency invoked by a JS script than a global, and I would rather the docs be generated locally (via commands outlined in the README) or during a CI docs publication versus being checked in.

@hiemanshu hiemanshu marked this pull request as draft July 26, 2023 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants