From d8cf98a0b561eb67730b231e7676f256efab6e5b Mon Sep 17 00:00:00 2001 From: kmurphypolygon Date: Wed, 6 Mar 2024 14:21:33 +0100 Subject: [PATCH 1/2] commit skeleton docs site --- .gitignore | 12 ++++++ docs/README.md | 36 +++++++++++++++++ docs/digital-signatures.md | 1 + docs/hash-functions.md | 1 + docs/merkle-structures.md | 1 + docs/welcome.md | 1 + mkdocs.yml | 79 ++++++++++++++++++++++++++++++++++++++ requirements.txt | 3 ++ run.sh | 7 ++++ 9 files changed, 141 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/digital-signatures.md create mode 100644 docs/hash-functions.md create mode 100644 docs/merkle-structures.md create mode 100644 docs/welcome.md create mode 100644 mkdocs.yml create mode 100755 requirements.txt create mode 100755 run.sh diff --git a/.gitignore b/.gitignore index d4a844e35..d0204f5bc 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,15 @@ cmake-build-* # VS Code .vscode/ + +# Docs ignore +.code +.idea +site/ +venv/ +env/ +*.out +node_modules/ +*DS_Store +*.iml + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..1f34ac90c --- /dev/null +++ b/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). \ No newline at end of file diff --git a/docs/digital-signatures.md b/docs/digital-signatures.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/digital-signatures.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/docs/hash-functions.md b/docs/hash-functions.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/hash-functions.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/docs/merkle-structures.md b/docs/merkle-structures.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/merkle-structures.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/docs/welcome.md b/docs/welcome.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/welcome.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..45e2b15cb --- /dev/null +++ b/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 diff --git a/requirements.txt b/requirements.txt new file mode 100755 index 000000000..4c9b0d58b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +mkdocs-material==9.4.8 +markdown-include==0.8.1 +mkdocs-open-in-new-tab==1.0.3 diff --git a/run.sh b/run.sh new file mode 100755 index 000000000..7ec676851 --- /dev/null +++ b/run.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 \ No newline at end of file From 03639148d73ed7e9e5c63f3a2e30ef811fc124c4 Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Tue, 12 Mar 2024 11:29:38 +0100 Subject: [PATCH 2/2] change run script name --- run.sh => run-docs-site.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename run.sh => run-docs-site.sh (100%) diff --git a/run.sh b/run-docs-site.sh similarity index 100% rename from run.sh rename to run-docs-site.sh