Add initial draft

unchainedshop · Aug 19, 2020 · f957000 · f957000
1 parent 37e9542
commit f957000
Show file tree

Hide file tree

Showing 83 changed files with 32,980 additions and 0 deletions.
diff --git a/docs/code_of_conduct.md → code_of_conduct.md b/docs/code_of_conduct.md → code_of_conduct.md
diff --git a/docs/contributing.md → contributing.md b/docs/contributing.md → contributing.md
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,10 @@
+.DS_Store
+Thumbs.db
+db.json
+*.log
+node_modules/
+public/*
+.deploy*/
+docs.json
+_multiconfig.yml
+.cache
diff --git a/docs/.nvmrc b/docs/.nvmrc
@@ -0,0 +1 @@
+12
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,29 @@
+# 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/apollo-server/
+
+## 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.
diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js
@@ -0,0 +1,44 @@
+const themeOptions = require('@unchainedshop/gatsby-theme-apollo-docs/theme-options');
+
+module.exports = {
+  pathPrefix: '/docs/unchained',
+  plugins: [
+    {
+      resolve: '@unchainedshop/gatsby-theme-apollo-docs',
+      options: {
+        ...themeOptions,
+        root: __dirname,
+        subtitle: 'Unchained Engine',
+        description: 'A guide to using Unchained Engine',
+        githubRepo: 'unchainedshop/unchained',
+        defaultVersion: '2',
+        // versions: {
+        //   "1": "version-1"
+        // },
+        sidebarCategories: {
+          null: [
+            'index',
+            'getting-started',
+            '[Changelog](https://github.com/unchainedshop/unchained/releases)',
+          ],
+          'Extending the API': [
+            'schema/schema',
+            'schema/scalars-enums',
+            'schema/unions-interfaces',
+            'schema/directives',
+            'schema/creating-directives',
+          ],
+          'Fetching Data': [
+            'data/resolvers',
+            'data/data-sources',
+            'data/errors',
+            'data/file-uploads',
+            'data/subscriptions',
+          ],
+          'API Reference': ['api/unchained'],
+          Appendices: [],
+        },
+      },
+    },
+  ],
+};