Commit skeleton docs site

.gitignore

@@ -14,3 +14,15 @@ cmake-build-*
 
 # VS Code
 .vscode/
+
+# Docs ignore
+.code
+.idea
+site/
+venv/
+env/
+*.out
+node_modules/
+*DS_Store
+*.iml
+

docs/README.md

@@ -0,0 +1,36 @@
+# Miden base documentation
+
+Welcome to the Miden client repo docs.
+
+## Running locally
+
+### Prerequisites
+
+1. [Python 3.12](https://www.python.org/downloads/).
+2. [`virtualenv`](https://pypi.org/project/virtualenv/): Install using `pip3 install virtualenv`.
+
+### Setup
+
+1. Clone the repository.
+2. `cd` to the root.
+3. Run the `run.sh` script. You may need to make the script executable: `chmod +x run.sh`
+
+```sh
+./run.sh
+```
+
+The site comes up at http://127.0.0.1:8000/ 
+
+## Style guide
+
+We are using the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
+
+## Contributing
+
+1. Fork the `main` branch into your own GitHub account and create a feature branch for your changes.
+2. Commit changes and create a PR.
+
+## Contact
+
+- For docs issues (technical or language) open an issue here.
+- For anything else, join our [Discord](https://discord.gg/0xpolygondevs).

docs/digital-signatures.md

@@ -0,0 +1 @@
+WIP

docs/hash-functions.md

@@ -0,0 +1 @@
+WIP

docs/merkle-structures.md

@@ -0,0 +1 @@
+WIP

docs/welcome.md

@@ -0,0 +1 @@
+WIP

mkdocs.yml

@@ -0,0 +1,79 @@
+site_name: Miden client
+theme:
+  name: material
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+    # - navigation.instant
+    - navigation.instant.progress
+    - navigation.tracking
+    - navigation.integration
+    #- navigation.tabs
+    #- navigation.tabs.sticky
+    - navigation.indexes
+    #- navigation.sections
+    - navigation.path
+    - navigation.top
+    - navigation.footer
+    - toc.follow
+    - content.code.copy
+    - content.action.edit
+
+
+nav:
+  - Welcome: welcome.md
+  - Hash functions: hash-functions.md
+  - Merkle structures: merkle-structures.md
+  - Digital signatures: digital-signatures.md
+
+
+
+markdown_extensions:
+  - toc:
+      permalink: true
+      permalink_title: Link to this section
+      toc_depth: 4
+  - codehilite
+  - markdown_include.include:
+      base_path: src
+  - admonition
+  - footnotes
+  - def_list
+  - attr_list
+  - abbr
+  - pymdownx.tabbed
+  - pymdownx.superfences
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.keys
+  - pymdownx.details
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.caret
+  - meta
+  - smarty
+  - pymdownx.extra
+
+plugins:
+  - search
+  - open-in-new-tab
+
+validation:
+  absolute_links: warn
+
+extra_javascript:
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js  
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
+
+extra_css:
+  - https://fonts.googleapis.com/icon?family=Material+Icons
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material==9.4.8
+markdown-include==0.8.1
+mkdocs-open-in-new-tab==1.0.3

run-docs-site.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+virtualenv venv
+source venv/bin/activate
+pip3 install -r requirements.txt
+mkdocs serve --strict