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

Update introspection docs #1812

Open
wants to merge 4 commits into
base: source
Choose a base branch
from
Open

Update introspection docs #1812

wants to merge 4 commits into from

Conversation

mandiwise
Copy link
Contributor

Description

This PR contains updated introspection content for the Learn docs. Key changes include:

  • A new section on type name introspection
  • Documentation comments in the demo schema have been turned into description strings so they may be queried in mini GraphiQL (fixes last example where description field returned null)
  • Added comment on why introspection may not be available in production
  • Light editing throughout the Introspection page

@benjie @jorydotcom

@vercel Vercel
Copy link

vercel bot commented Nov 2, 2024

@mandiwise is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel.

A member of the Team first needs to authorize it.

benjie
benjie requested changes Nov 7, 2024
View reviewed changes
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this editorial and expansion, especially adding a section on disabling introspection in production (though I have comments on what that section should contain 😉)

src/pages/learn/introspection.mdx Outdated Show resolved Hide resolved
src/pages/learn/introspection.mdx Outdated Show resolved Hide resolved
src/pages/learn/introspection.mdx Outdated Show resolved Hide resolved
src/pages/learn/introspection.mdx Outdated Show resolved Hide resolved
src/pages/learn/introspection.mdx Outdated Show resolved Hide resolved
@mandiwise mandiwise mentioned this pull request Nov 8, 2024
Open
benjie
benjie approved these changes Nov 8, 2024
View reviewed changes
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work; I think this is good to go with or without the suggestion above 🙌

@vercel Vercel
Copy link

vercel bot commented Nov 8, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
graphql-github-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 1:55pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjie benjie benjie approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mandiwise @benjie