Merge pull request #186 from alan-turing-institute/mkdocs

New documentation site built with Material for MkDocs (#173)
alan-turing-institute · Jul 17, 2024 · 90baff8 · 90baff8
2 parents 02e31d0 + 1363f07
commit 90baff8
Show file tree

Hide file tree

Showing 44 changed files with 2,707 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,29 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -31,3 +31,6 @@ outputs/
 
 # dist paths
 **/dist
+
+# OS
+.DS_Store
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,6 +3,7 @@ repos:
     rev: v2.3.0
     hooks:
     -   id: check-yaml
+        args: [--unsafe]
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/doublify/pre-commit-rust

diff --git a/docs/.nojekyll → docs-docsify/.nojekyll b/docs/.nojekyll → docs-docsify/.nojekyll
diff --git a/docs/README.md → docs-docsify/README.md b/docs/README.md → docs-docsify/README.md
diff --git a/docs/_coverpage.md → docs-docsify/_coverpage.md b/docs/_coverpage.md → docs-docsify/_coverpage.md
diff --git a/docs/_sidebar.md → docs-docsify/_sidebar.md b/docs/_sidebar.md → docs-docsify/_sidebar.md
diff --git a/docs-docsify/acknowledgements.md b/docs-docsify/acknowledgements.md
@@ -0,0 +1,2 @@
+# Acknowledgements
+This work was supported, in whole or in part, by the Bill & Melinda Gates Foundation [INV-001309].
diff --git a/docs/figs/Issuer-Holder.png → docs-docsify/figs/Issuer-Holder.png b/docs/figs/Issuer-Holder.png → docs-docsify/figs/Issuer-Holder.png
diff --git a/docs/figs/TrustChainUI.png → docs-docsify/figs/TrustChainUI.png b/docs/figs/TrustChainUI.png → docs-docsify/figs/TrustChainUI.png
diff --git a/docs/figs/Verification.png → docs-docsify/figs/Verification.png b/docs/figs/Verification.png → docs-docsify/figs/Verification.png
diff --git a/docs/figs/dDID_schematic.png → docs-docsify/figs/dDID_schematic.png b/docs/figs/dDID_schematic.png → docs-docsify/figs/dDID_schematic.png
diff --git a/docs/index.html → docs-docsify/index.html b/docs/index.html → docs-docsify/index.html
diff --git a/docs/installation.md → docs-docsify/installation.md b/docs/installation.md → docs-docsify/installation.md
diff --git a/docs/license_disclaimer.md → docs-docsify/license_disclaimer.md b/docs/license_disclaimer.md → docs-docsify/license_disclaimer.md
@@ -1,4 +1,4 @@
 # License & disclaimer
 Trustchain is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
 
-See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.
+See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.
diff --git a/docs/theme-custom.css → docs-docsify/theme-custom.css b/docs/theme-custom.css → docs-docsify/theme-custom.css
@@ -27,4 +27,4 @@
     --cover-heading-font-size-min                      : var(--font-size-s);
     --cover-heading-font-size-max                      : var(--font-size-s);
     --cover-heading-font-weight                        : bold;
-  }
+  }
diff --git a/docs/theme-style.css → docs-docsify/theme-style.css b/docs/theme-style.css → docs-docsify/theme-style.css
diff --git a/docs/turing.svg → docs-docsify/turing.svg b/docs/turing.svg → docs-docsify/turing.svg
diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1,15 @@
+nav:
+    - index.md
+    - use-cases.md
+    - roles.md
+    - getting-started.md
+    - usage.md
+    # - deployment.md
+    - faq.md
+    # - glossary.md
+    - technical-notes.md
+    # - dev-guide.md
+    - ion.md
+    - contributing.md
+    - license.md
+    - acknowledgements.md
diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
@@ -1,2 +1,5 @@
 # Acknowledgements
-This work was supported, in whole or in part, by the Bill & Melinda Gates Foundation [INV-001309].
+
+Trustchain was developed at the Alan Turing Institute, the UK's national institute for data science and artificial intelligence.
+
+This work was supported, in whole or in part, by the Bill & Melinda Gates Foundation [INV-001309].
diff --git a/docs/assets/bitcoind-allow-anyway.png b/docs/assets/bitcoind-allow-anyway.png
diff --git a/docs/assets/bitcoind-macOS-pop-up.png b/docs/assets/bitcoind-macOS-pop-up.png
diff --git a/docs/assets/figs/constrained_dDID.svg b/docs/assets/figs/constrained_dDID.svg
diff --git a/docs/assets/figs/dDID_anatomy.svg b/docs/assets/figs/dDID_anatomy.svg
diff --git a/docs/assets/trustchain-icon-circular-thick.png b/docs/assets/trustchain-icon-circular-thick.png
diff --git a/docs/assets/trustchain-icon-circular.png b/docs/assets/trustchain-icon-circular.png
diff --git a/docs/assets/trustchain-icon.png b/docs/assets/trustchain-icon.png
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,5 @@
+# Contributing
+
+Trustchain is free and open source software, and we welcome contributions from open source developers.
+
+If you would like to contribute, please take a look at our [open issues](https://github.com/alan-turing-institute/trustchain/issues).
diff --git a/docs/deployment.md b/docs/deployment.md
@@ -0,0 +1 @@
+# Deployment