034383f491
In an effort to maintain consistency and semantically correct meaning, this changes (only in documentation and internal Apollo Server tests) the name of the first argument in resolver signatures to use `parent` rather than `root`. While `root` certainly makes sense when the resolver is belonging to the root `Query` or `Mutation` type, once nested field resolvers begin getting called, the more semantically correct term would seem to be `parent`. Since `parent` still makes sense at the root level, and since resolvers frequently get copied and pasted into more deeply-nested positions, putting this pattern in place for apps which are just beginning might just help someone more clearly understand the relationship in the future — without incorrectly thinking that a nested resolver is accessing the root of the graph, rather than the parent. |
||
|---|---|---|
| .. | ||
| assets | ||
| sketch | ||
| source | ||
| .gitignore | ||
| .nvmrc | ||
| _config.yml | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
Documentation
This is the documentation source for this repository.
The deployed version of the documentation for this repository is available at:
Documentation for the documentation
This README.md is intentionally short since the documentation for the documentation provides details for the documentation framework itself. Additional information should generally be added to that documentation rather than here in this README.md, in order to provide a centralized resource that benefits all documentation deployments.
Running locally
For more information, consult the documentation for the documentation, referenced above.
In general though:
npm installin this directorynpm startin this directory- Open a browser to the link provided in the console.
Important note: Changes to the markdown source does not result in an automatic "hot reload" in the browser; it is necessary to reload the page manually in the browser to see it re-rendered. Additionally, changes to
_config.ymlrequire stopping the server and restarting withnpm startagain.
Deploy previews
Documentation repositories should be setup with a "deploy preview" feature which automatically provides "preview" links in the status checks section of pull-requests.
In the event that it's not possible to run the documentation locally, pushing changes to the branch for a pull-request can be a suitable alternative that ensures changes to the documentation are properly rendered.