Skip to content

[HotChocolate] Reworked Schema Docs#9677

Merged
michaelstaib merged 12 commits into
mainfrom
mst/docs-review
May 11, 2026
Merged

[HotChocolate] Reworked Schema Docs#9677
michaelstaib merged 12 commits into
mainfrom
mst/docs-review

Conversation

@michaelstaib

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings May 11, 2026 23:50
@github-actions github-actions Bot added 📚 documentation This issue is about working on our documentation. 🌶️ website labels May 11, 2026
@michaelstaib michaelstaib merged commit e997f44 into main May 11, 2026
8 checks passed
@michaelstaib michaelstaib deleted the mst/docs-review branch May 11, 2026 23:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR restructures and refreshes Hot Chocolate v16 (and some Mocha) documentation, primarily by reorganizing sections (schema/type system, data fetching, security) and updating internal links and callout formatting to match the new structure.

Changes:

  • Reorganized Hot Chocolate v16 docs navigation and link structure (e.g., building-a-schemadefining-a-schema, resolvers-and-datafetching-data, securing-your-apisecurity, removed integrations index).
  • Added/expanded key v16 docs pages (notably the new type-system overview and a dedicated dependency injection page) and updated many cross-references accordingly.
  • Updated docs.json to reflect v16 as stable (and adjusted sidebar structure accordingly).

Reviewed changes

Copilot reviewed 84 out of 85 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
website/src/docs/mocha/v16/transports/rabbitmq.md Converts warning callout formatting to blockquote style.
website/src/docs/mocha/v16/transports/postgres.md Converts warning callout formatting to blockquote style.
website/src/docs/mocha/v16/transports/in-memory.md Converts note callout formatting to blockquote style.
website/src/docs/mocha/v16/reliability.md Converts note callout formatting to blockquote style.
website/src/docs/mocha/v16/exception-policies.md Converts note callout formatting to blockquote style.
website/src/docs/hotchocolate/v16/server/warmup.md Updates dynamic-schemas links to new v16 docs structure.
website/src/docs/hotchocolate/v16/server/options.md Updates pagination link to fetching-data section.
website/src/docs/hotchocolate/v16/server/interceptors.md Updates next-step links to new v16 doc paths.
website/src/docs/hotchocolate/v16/server/index.md Updates DI/introspection links to new v16 doc paths.
website/src/docs/hotchocolate/v16/server/http-transport.md Updates subscriptions link path; removes redundant code-block filename comment.
website/src/docs/hotchocolate/v16/server/global-state.md Updates DI link to new v16 doc path.
website/src/docs/hotchocolate/v16/server/files.md Updates schema-building links (arguments/input objects/lists) to new v16 paths.
website/src/docs/hotchocolate/v16/server/endpoints.md Updates Trusted Documents + Cost Analysis links to new v16 paths.
website/src/docs/hotchocolate/v16/server/cache-control.md Converts note callout; updates options reference link to server/options.
website/src/docs/hotchocolate/v16/security/request-limits.md Updates cost analysis/introspection/security overview links to new v16 paths.
website/src/docs/hotchocolate/v16/security/introspection.md Updates unions link to new defining-a-schema path.
website/src/docs/hotchocolate/v16/security/index.md Updates security section links to new v16 paths and security structure.
website/src/docs/hotchocolate/v16/security/cost-analysis.md Removes inline filename comments and updates security links in Next Steps.
website/src/docs/hotchocolate/v16/security/authorization.md Updates authentication/cost-analysis links; removes inline filename comments.
website/src/docs/hotchocolate/v16/security/authentication.md Updates authorization link; removes inline filename comments.
website/src/docs/hotchocolate/v16/migrating/migrate-from-13-to-14.md Updates Entity Framework documentation link target.
website/src/docs/hotchocolate/v16/migrating/migrate-from-12-to-13.md Updates Entity Framework documentation links/anchors.
website/src/docs/hotchocolate/v16/integrations/index.md Removes v16 integrations overview page.
website/src/docs/hotchocolate/v16/index.md Reworks schema authoring/security strategy introduction; updates numerous links.
website/src/docs/hotchocolate/v16/guides/testing.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/guides/schema-evolution.md Updates schema documentation/versioning links; removes inline filename comments.
website/src/docs/hotchocolate/v16/guides/public-api.md Updates schema docs/versioning/pagination/security links; removes inline filename comments.
website/src/docs/hotchocolate/v16/guides/performance.md Updates data-fetching/security/options links; removes inline filename comments.
website/src/docs/hotchocolate/v16/guides/openapi-adapter.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/guides/mcp-adapter.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/guides/federation.md Updates resolver/DataLoader links to fetching-data.
website/src/docs/hotchocolate/v16/guides/error-handling.md Updates mutations/schema-basics/data fetching links to new v16 paths; removes inline filename comments.
website/src/docs/hotchocolate/v16/guides/dynamic-schemas.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/get-started-with-graphql-in-net-core.md Updates DataLoader/Entity Framework links to new v16 paths; removes inline filename comments.
website/src/docs/hotchocolate/v16/fetching-data/spatial-data.md Updates next-step links to new fetching-data paths.
website/src/docs/hotchocolate/v16/fetching-data/sorting.md Removes inline filename comments; updates next-step links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/resolvers.md Removes inline filename comments; updates DI + next-step links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/projections.md Removes inline filename comments; updates next-step links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/pagination.md Removes inline filename comments; updates projections/security/next-step links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/mongodb.md Updates pagination/executable/filtering links to new v16 paths.
website/src/docs/hotchocolate/v16/fetching-data/marten.md Updates filtering/sorting/projections/pagination links to new v16 paths.
website/src/docs/hotchocolate/v16/fetching-data/index.md Updates internal links to point at the new fetching-data subpages.
website/src/docs/hotchocolate/v16/fetching-data/filtering.md Removes inline filename comments; updates next-step links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/fetching-from-rest.md Removes inline filename comments; updates DataLoader/resolvers links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/fetching-from-databases.md Removes inline filename comments; updates integration/data-fetching links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/extending-filtering.md Updates filtering/mongodb links to new paths.
website/src/docs/hotchocolate/v16/fetching-data/executable.md Updates integration/filtering links to new v16 locations.
website/src/docs/hotchocolate/v16/fetching-data/errors.md Updates mutation/options links to new v16 locations.
website/src/docs/hotchocolate/v16/fetching-data/entity-framework.md Updates dependency injection links to new v16 location.
website/src/docs/hotchocolate/v16/fetching-data/dependency-injection.md Adds a new dedicated v16 dependency injection page for resolvers/schema services.
website/src/docs/hotchocolate/v16/fetching-data/dataloader.md Updates internal links to new v16 data-fetching structure.
website/src/docs/hotchocolate/v16/execution-engine/index.md Updates “Error handling” link target.
website/src/docs/hotchocolate/v16/execution-engine/field-middleware.md Updates next-step links to new v16 data-fetching structure.
website/src/docs/hotchocolate/v16/defining-a-schema/versioning.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/unions.md Removes inline filename comments; significantly expands union vs interface guidance.
website/src/docs/hotchocolate/v16/defining-a-schema/subscriptions.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/relay.md Updates DataLoader links to new v16 location; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/queries.md Updates resolver/DataLoader links to new v16 location; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/object-types.md Expands guidance on resolver placement/naming/ignoring fields/descriptions; updates links; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/non-null.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/mutations.md Updates DataLoader link to new v16 location; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/lists.md Updates pagination/filtering/sorting links to new v16 location; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/interfaces.md Removes inline filename comments; adds “Default Resolvers” section.
website/src/docs/hotchocolate/v16/defining-a-schema/input-object-types.md Clarifies “input object type” wording; removes inline filename comments.
website/src/docs/hotchocolate/v16/defining-a-schema/index.md Adds a new “Type System” overview page for the defining-a-schema section.
website/src/docs/hotchocolate/v16/defining-a-schema/enums.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/dynamic-schemas.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/documentation.md Removes inline filename comments from code samples.
website/src/docs/hotchocolate/v16/defining-a-schema/directives.md Adds a new expanded directives page under defining-a-schema.
website/src/docs/hotchocolate/v16/defining-a-schema/arguments.md Adds DefaultValueSyntax guidance; updates resolvers link to new v16 location; removes inline filename comments.
website/src/docs/hotchocolate/v16/building-a-schema/index.md Removes the old building-a-schema overview page.
website/src/docs/hotchocolate/v16/building-a-schema/extending-types.md Removes the old extending-types page under building-a-schema.
website/src/docs/hotchocolate/v16/building-a-schema/directives.md Removes the old directives page under building-a-schema.
website/src/docs/hotchocolate/v16/api-reference/visitors.md Removes the old v16 Visitors API reference page.
website/src/docs/hotchocolate/v16/api-reference/language.md Removes the old v16 Language API reference page.
website/src/docs/hotchocolate/v16/api-reference/custom-attributes.md Removes the old v16 attribute reference page.
website/src/docs/docs.json Promotes v16 to stable in multiple products; updates section paths/sidebars (e.g., fetching-data, defining-a-schema, security).
website-next/content/docs/mocha/transports/rabbitmq.md Mirrors Mocha warning callout formatting change for the “website-next” docs.
website-next/content/docs/mocha/transports/postgres.md Mirrors Mocha warning callout formatting change for the “website-next” docs.
website-next/content/docs/mocha/transports/in-memory.md Mirrors Mocha note callout formatting change for the “website-next” docs.
website-next/content/docs/mocha/reliability.md Mirrors Mocha note callout formatting change for the “website-next” docs.
website-next/content/docs/mocha/exception-policies.md Mirrors Mocha note callout formatting change for the “website-next” docs.
website-next/content/docs/hotchocolate/server/cache-control.md Mirrors note callout formatting change for the “website-next” docs.
website-next/content/docs/hotchocolate/building-a-schema/interfaces.md Mirrors the “Default Resolvers” addition for the “website-next” docs.
Comments suppressed due to low confidence (3)

website/src/docs/hotchocolate/v16/security/cost-analysis.md:394

  • /docs/hotchocolate/v16/security/query-depth is linked here, but there is no query-depth.md page in v16 security docs. Either add the missing Query Depth page (as exists in v15) or change this link to the correct v16 location/section (e.g., request limits/execution depth).
    website/src/docs/hotchocolate/v16/fetching-data/extending-filtering.md:292
  • This page links to /docs/hotchocolate/v16/api-reference/visitors, but the v16 api-reference/visitors page was removed. Update this reference to wherever the visitor documentation moved, or reintroduce the Visitors page to avoid a broken link.
    website/src/docs/hotchocolate/v16/fetching-data/resolvers.md:320
  • This links to /docs/hotchocolate/v16/defining-a-schema/extending-types, but that page does not exist in v16. Either add the missing Extending Types doc or point this to the correct replacement section/page so readers don’t hit a 404.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

When enabled, requests to `/{operationId}` without an operation name return a `400 Bad Request` response.

For details on storing and managing persisted operations, see [Trusted Documents](/docs/hotchocolate/v16/securing-your-api/trusted-documents).
For details on storing and managing persisted operations, see [Trusted Documents](/docs/hotchocolate/v16/security/trusted-documents).
- [Interceptors](/docs/hotchocolate/v16/server/interceptors) for hooking into request processing.
- [Trusted Documents](/docs/hotchocolate/v16/securing-your-api/trusted-documents) for the full persisted operations workflow.
- [Cost Analysis](/docs/hotchocolate/v16/securing-your-api/cost-analysis) for understanding the default security cost analyzer.
- [Trusted Documents](/docs/hotchocolate/v16/security/trusted-documents) for the full persisted operations workflow.
- Use `RegisterDbContextFactory` to register a DbContext factory.

For more information, see the [Entity Framework integration](/docs/hotchocolate/v14/integrations/entity-framework) documentation.
For more information, see the [Entity Framework integration](/docs/hotchocolate/v14/fetching-data/entity-framework) documentation.
Comment on lines +86 to +88
We changed the default [DbContextKind](/docs/hotchocolate/v13/fetching-data/entity-framework#dbcontextkind) from [DbContextKind.Synchronized](/docs/hotchocolate/v13/fetching-data/entity-framework#dbcontextkindsynchronized) to [DbContextKind.Resolver](/docs/hotchocolate/v13/fetching-data/entity-framework#dbcontextkindresolver). If the instance of your `DbContext` doesn't need to be the same for each executed resolver during a request, this should lead to a performance improvement.

To restore the v12 default behavior, pass the [DbContextKind.Synchronized](/docs/hotchocolate/v13/integrations/entity-framework#dbcontextkindsynchronized) to the `RegisterDbContext<T>` call.
To restore the v12 default behavior, pass the [DbContextKind.Synchronized](/docs/hotchocolate/v13/fetching-data/entity-framework#dbcontextkindsynchronized) to the `RegisterDbContext<T>` call.
In this release, we are deprecating the `[ScopedService]` attribute and encourage you to use `RegisterDbContext<T>(DbContextKind.Pooled)` instead.

Checkout [this part of our Entity Framework documentation](/docs/hotchocolate/v13/integrations/entity-framework#registerdbcontext) to learn how to register your `DbContext` with `DbContextKind.Pooled`.
Checkout [this part of our Entity Framework documentation](/docs/hotchocolate/v13/fetching-data/entity-framework#registerdbcontext) to learn how to register your `DbContext` with `DbContextKind.Pooled`.
Comment on lines +178 to +181
| Topic | Use it for | Learn more |
| --------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Type extensions | Split large object or root type definitions across classes. Extensions are merged into the final schema. | [Extending Types](./extending-types) |
| Relay helpers | Use stable IDs, global object identification, `node`, `nodes`, `[ID]`, `[Node]`, and `[NodeResolver]`. | [Relay](./relay) |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 documentation This issue is about working on our documentation. 🌶️ website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants