Add documentation (#87)

* Add documentation

* Add test action

* Update wiki cli

* Change branch

* Change branch. Again

* Thoralf wants working stuff

Co-authored-by: Thoralf-M <[email protected]>

Co-authored-by: Thoralf-M <[email protected]>

.github/workflows/test-docs-build.yml

@@ -0,0 +1,21 @@
+name: Test Docs Build
+
+on:
+  pull_request:
+    branches:
+      - develop
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test Build
+        run: |
+          cd documentation
+          yarn install --immutable
+          yarn build

documentation/.gitignore

@@ -0,0 +1,29 @@
+# Dependencies
+node_modules
+
+# Yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

documentation/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.2.0.cjs

documentation/README.md

@@ -0,0 +1,36 @@
+# Documentation
+
+The documentation is built using [Docusaurus 2](https://docusaurus.io/). The deployment is done through a centralized build from [IOTA WIKI](https://github.com/iota-community/iota-wiki). To run a local instance the [IOTA WIKI CLI](https://github.com/iota-community/iota-wiki-cli) is used.
+
+## Prerequisites
+
+- [Node.js v14.14+](https://nodejs.org/en/)
+- [yarn](https://yarnpkg.com/getting-started/install)
+
+## Installation
+
+```console
+yarn
+```
+
+This command installs all necessary dependencies.
+
+## Local Development
+
+```console
+yarn start
+```
+
+This command starts a local, wiki themed development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Including .md file
+
+```console
+{@import <file path>}
+```
+
+Example:
+
+```console
+{@import ../README.md}
+```

documentation/docusaurus.config.js

@@ -0,0 +1,17 @@
+const path = require('path');
+
+module.exports = {
+    plugins: [
+        [
+            '@docusaurus/plugin-content-docs',
+            {
+                id: 'cli-wallet',
+                path: path.resolve(__dirname, 'docs'),
+                routeBasePath: 'cli-wallet',
+                sidebarPath: path.resolve(__dirname, 'sidebars.js'),
+                editUrl: 'https://github.com/iotaledger/cli-wallet/edit/develop/documentation',
+            }
+        ],
+    ],
+    staticDirectories: [path.resolve(__dirname, 'static')],
+};

documentation/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "cli-wallet",
+    "version": "0.0.0",
+    "private": true,
+    "scripts": {
+        "start": "iota-wiki start",
+        "build": "iota-wiki build"
+    },
+    "license": "UNLICENSED",
+    "engines": {
+        "node": ">=14.14.0"
+    },
+    "devDependencies": {
+        "@iota-community/iota-wiki-cli": "iota-community/iota-wiki-cli#v2"
+    },
+    "packageManager": "[email protected]"
+}

documentation/sidebars.js

@@ -0,0 +1,31 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+    // By default, Docusaurus generates a sidebar from the docs folder structure
+    tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
+
+    // But you can create a sidebar manually
+    /*
+    tutorialSidebar: [
+      {
+        type: 'category',
+        label: 'Tutorial',
+        items: ['hello'],
+      },
+    ],
+     */
+};
+
+module.exports = sidebars;