Skip to content

Commit 7514bdd

Browse files
docs: place the import-performance and fragments guides in the docs site
The use_alias_generator branch predates the docs-site refactor (#446), so it added these two guides as flat docs/07 and docs/08 pages and linked them from a monolithic README. Move them under docs/02-guides/ to match the current structure and repoint the config-reference links. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 927db41 commit 7514bdd

2 files changed

Lines changed: 1 addition & 1 deletion

File tree

docs/07-improving-import-performance.md renamed to docs/02-guides/13-improving-import-performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Both options are opt-in, and neither changes generated code until you set it: a
3030

3131
`use_alias_generator` does not change what any field is called on the wire. Names that `to_camel` cannot reconstruct keep an explicit `Field(alias=...)`: `__typename`, keyword-escaped names such as `list_`, acronyms such as `productID`, and schemas whose fields are already snake_case (`some_field` would otherwise become `someField`). The same holds with `convert_to_snake_case = false`, where field names already match the schema and every renamed field keeps its alias - which also means there is nothing to gain there, so leave `use_alias_generator` off unless you convert to snake_case.
3232

33-
Two caveats. `defer_model_build` moves the build cost to first use rather than removing it, so a short-lived process that touches every model pays it anyway. And because `alias_generator` is set on the shared `BaseModel`, it also applies to fields you add through [custom mixins](https://github.com/mirumee/ariadne-codegen/blob/main/README.md#extending-models-with-custom-mixins) - name those in snake_case and they will be aliased to camelCase.
33+
Two caveats. `defer_model_build` moves the build cost to first use rather than removing it, so a short-lived process that touches every model pays it anyway. And because `alias_generator` is set on the shared `BaseModel`, it also applies to fields you add through [custom mixins](./07-extending-types.md#extending-models-with-custom-mixins) - name those in snake_case and they will be aliased to camelCase.
File renamed without changes.

0 commit comments

Comments
 (0)