85b97b6f0c
* docs: Correct path for GraphQL Playground. This corrects the documentation which incorrectly stated that the message on the console would include `http://localhost:4000/graphql`. While the `/graphql` URL will also serve the GraphQL Playground, it's only working as a by-product of of `/graphql` being included within the (higher) `/` path. (That is to say that `/any-url` would also respond!). * [squash] Tweak per feedback. cc @evans |
||
|---|---|---|
| .. | ||
| assets | ||
| sketch | ||
| source | ||
| .gitignore | ||
| .nvmrc | ||
| _config.yml | ||
| 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.