Polish Introduction and Root Type Docs#9640
Open
michaelstaib wants to merge 1 commit intomainfrom
Open
Conversation
github-actions
Bot
added
📚 documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Hot Chocolate v16 documentation to refine the overview narrative, clarify API categorization (first-party vs third-party), and align several “Next Steps” links and snippets with the current docs structure and tooling outputs.
Changes:
- Refines the v16 overview page wording and terminology (including first-party vs third-party API guidance).
- Updates Getting Started snippet/output description (e.g.,
AddTypes(), exported files). - Fixes “Next Steps” links to point at
/building-a-schema/*and adjusts docs navigation ordering.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/docs/hotchocolate/v16/index.md | Updates overview narrative and terminology around schema-building and API types. |
| website/src/docs/hotchocolate/v16/get-started-with-graphql-in-net-core.md | Adjusts setup snippet and clarifies schema export outputs. |
| website/src/docs/hotchocolate/v16/building-a-schema/queries.md | Fixes “Next Steps” links to the correct v16 paths. |
| website/src/docs/hotchocolate/v16/building-a-schema/mutations.md | Removes the transactions section and fixes “Next Steps” links to the correct v16 paths. |
| website/src/docs/docs.json | Reorders a couple of navigation entries for Fusion/Hot Chocolate guides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **DataLoader** | A batching and caching layer that groups multiple individual data requests into a single batch call, eliminating the N+1 problem. | | ||
| | **Source generator** | A Roslyn source generator that inspects your C# code at build time and generates the schema registration, resolver pipelines, and DataLoader infrastructure. | | ||
| | **Cost analysis** | A static analysis pass that calculates the cost of a query before execution and rejects queries that exceed configured limits. Based on the [IBM Cost Analysis specification](https://ibm.github.io/graphql-specs/cost-spec.html). | | ||
| | **Cost Control** | A static analysis pass that calculates the cost of a query before execution and rejects queries that exceed configured limits. Based on the [IBM Cost Analysis specification](https://ibm.github.io/graphql-specs/cost-spec.html). | |
| @@ -33,7 +33,7 @@ public static partial class ProductQueries | |||
|
|
|||
| The source generator creates a `book` field on the Query type, infers argument types from the method parameters, and registers everything with the schema. You do not write GraphQL SDL or configure type descriptors. | |||
| ## First-Party API | ||
|
|
||
| A public API is consumed by third-party developers or external clients. GitHub's GraphQL API is the canonical example. You publish a schema, and external teams build applications against it. Because you do not control the clients, they can send any operation they want. | ||
| A first-party API is consumed by your own applications. This is how Meta, Netflix or X built and operate their GraphQL APIs internally. You control both the server and every client. This means that you know every operation at deployment time. |
| ## Third-Party API | ||
|
|
||
| A private API is consumed by your own applications. This is how Meta built and operates GraphQL internally. You control both the server and every client. You know every operation at build time. | ||
| A Third-Party API is consumed by third-party developers or external clients. GitHub's GraphQL API is a great example for a third-party GraphQL API. You publish a schema, and external teams build applications against it. Because you do not control the clients, they can send any operation they want. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.