From 09fc19ad1dc8a092443ed9c0a3e479c4a1396ff8 Mon Sep 17 00:00:00 2001 From: Jesse Rosenberger Date: Mon, 18 Jun 2018 14:14:17 +0300 Subject: [PATCH] docs: Add/update documentation README.md. --- docs/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..51d58f4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,30 @@ +# Documentation + +This is the documentation **source** for this repository. + +The **deployed** version of the documentation for this repository is available at: + +* https://www.apollographql.com/docs/ + +## Documentation for the documentation + +This `README.md` is intentionally short since the [documentation for the documentation](https://docs-docs.netlify.com/docs/docs/) 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 install` in this directory +* `npm start` in 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.yml` require stopping the server and restarting with `npm start` again. + +## 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. +