chore: README/documentation

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+xtask = "run --package xtask --"

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,3 @@
+## 👉 [Please follow one of these issue templates](https://github.com/monadicus/snarkops/issues/new/choose) 👈
+
+**NOTE**: In order to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above templates.

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,46 @@
+---
+name: 🐛 Bug Report
+about: Submit a bug report if something isn't working
+title: "🐛 "
+labels: "type: bug"
+---
+
+## 🐛 Bug Report
+
+<!--
+	What's the bug that you found?
+	How serious is this bug, and what is affected? What module(s) are concerned?
+-->
+
+(Write your description here)
+
+## Steps to Reproduce
+
+<!--
+	How can we reproduce this issue?
+-->
+
+#### Code snippet to reproduce
+
+```
+# Add code here if relevent
+```
+
+#### Stack trace & error message
+
+```
+// Paste the output here
+```
+
+## Expected Behavior
+
+<!--
+	What was supposed to happen?
+	What happened instead?
+-->
+
+## Your Environment
+
+- <!-- Project version -->
+- <!-- Language versions -->
+- <!-- Computer OS and version -->

.github/ISSUE_TEMPLATE/chore.md

@@ -0,0 +1,25 @@
+---
+name: 🔧 Chore
+about: Submit a behind-the-scenes change request
+title: "🔧 "
+labels: "type: chore"
+---
+
+## 🔧 Chore
+
+<!--
+	Is there some dirty code? Some minor change that wasn't done before? Or other small misc. tasks? Write them here.
+-->
+
+(Write what chore needs to be done)
+
+## Motivation
+
+<!--
+	Why should this change be made?
+-->
+
+(Outline your motivation here)
+
+**Are you willing to open a pull request?** (See
+[CONTRIBUTING](../../CONTRIBUTING.md))

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,14 @@
+---
+name: 📚 Documentation
+about: Report an issue related to documentation
+title: "📚 "
+labels: "type: documentation"
+---
+
+## 📚 Documentation
+
+<!--
+	Did you find a mistake in the documentation?
+	Is there missing documentation?
+	Is something not clear?
+-->

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,33 @@
+---
+name: ✨ Feature
+about: Submit a new feature request
+title: "✨ "
+labels: "type: feature"
+---
+
+## ✨ Feature
+
+<!--
+	What is the feature you would like to see?
+-->
+
+## Motivation
+
+<!--
+	Why should this feature be implemented?
+	How would this feature be used?
+	What module(s) does this affect?
+	Is this feature request related to a problem? If so, please describe.
+	Please link to any relevant issues or other PRs!
+-->
+
+## Implementation
+
+<!--
+	What needs to be built for the feature to be supported?
+	What module(s) does this feature affect? Or is it a new module?
+	How should this feature be implemented?
+-->
+
+**Are you willing to open a pull request?** (See
+[CONTRIBUTING](../../CONTRIBUTING.md))

.github/ISSUE_TEMPLATE/refactor.md

@@ -0,0 +1,31 @@
+---
+name: ♻️ Refactor
+about: Submit a code cleanup request
+title: "♻️ "
+labels: "type: refactor"
+---
+
+## ♻️ Refactor
+
+<!--
+  What needs to be refactored?
+-->
+
+## Motivation
+
+<!--
+	Why should this code be refactored?
+	What are the benefits in terms of:
+		- Developer experience
+		- Code maintainability
+		- Code readability
+-->
+
+## Implementation
+
+<!--
+	How does the code need to be changed? How do we guarantee no functionality is impacted?
+-->
+
+**Are you willing to open a pull request?** (See
+[CONTRIBUTING](../../CONTRIBUTING.md))

.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,30 @@
+---
+name: ✅ Task
+about: Submit a new Task
+title: "✅ "
+labels: "type: task"
+---
+
+## ✅ Task
+
+<!--
+	What is the task that needs to be done.
+-->
+
+## Motivation
+
+<!--
+	Is this task part of a feature?
+	What module(s) does this affect?
+	Please link to any relevant issues or other PRs!
+-->
+
+## Details
+
+<!--
+	What should be accomplished by this task?
+	What module(s) does this task affect? Or is it a new module?
+-->
+
+**Are you willing to open a pull request?** (See
+[CONTRIBUTING](../../CONTRIBUTING.md))

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+<!--
+	Thank you for submitting the PR! We appreciate you spending the time to work on these changes.
+
+	Please help us understand your motivation by explaining why you decided to make this change.
+
+	Happy contributing!
+-->
+
+## Motivation
+
+(Write your motivation here)
+
+## Explanation of Changes
+
+<!-- Please explain why you made these changes the way you did.  -->
+
+(Write your explanation here)
+
+## Testing
+
+<!--
+	How do you test these changes?
+	What command do you run to test these changes specifically?
+-->
+
+(Write your test plan here)
+
+## Related PRs and Issues
+
+<!--
+	Please link to any relevant Issues and PRs.
+-->
+
+(Link your related PRs and Issues here)

.github/workflows/mdbook.yml

@@ -0,0 +1,40 @@
+name: MDBook Deploy
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write # To push a branch
+  pages: write # To push to a GitHub Pages site
+  id-token: write # To update the deployment status
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: mdbook build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "book"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,9 +1,16 @@
+# rust files
 **/target/
+
+# snops files
 /tests
-/snot-control-data
-/snot-data
 /snops-control-data
 /snops-data
 /metrics-data
 /specs/local-*.yaml
+
+# vscode files
 .vscode/settings.json
+
+# mdbook files
+book
+index.html

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing
+
+This file describes the process for contributing to `snarkops`.
+
+## Starting
+
+<!-- TODO DEVELOPING DOCS -->
+<!-- Then please read the
+[developing instructions](https://github.com/monadicus/snarkops/blob/main/DEVELOPING.md) for setting up your environment. -->
+
+## Commits
+
+Your commits must follow specific guidelines.
+
+<!-- TODO IDR if we enforce this -->
+<!-- ### Signed Commits
+
+Sign all commits with a GPG key. GitHub has extensive documentation on how to:
+
+- [Create](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
+  a new GPG key.
+- [Add](https://docs.github.com/en/authentication/managing-commit-signature-verification/A-a-gpg-key-to-your-github-account)
+  a GPG key to your GitHub.
+- [Sign](https://docs.github.com/en/authentication/managing-commit-signature-verification/A-a-gpg-key-to-your-github-account)
+  your commits. -->
+
+### Convention
+
+All commits are to follow the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
+Commit messages should always be meaningful.
+
+## Getting Ready For a PR
+
+This section describes actions to keep in mind while developing.
+
+### Formatting and Cleanliness
+
+Please ensure your code is formatted and the formatting tool gives no warnings(if using a local snarkos/vm you can ignore warnings given from those repos).
+
+## PRs
+
+For creating the PR, please follow the instructions below.
+
+1. Firstly, please open a
+   [PR](https://github.com/monadicus/snarkops/pulls) from your branch
+   to the `main` branch of `snarkops`.
+2. Please fill in the PR template that is there.
+3. Then assign it to yourself and anyone else who worked on the issue with you.
+4. Make sure all CI tests pass.
+5. Finally, please assign at least two of the following reviewers to your PR:
+   - [gluax](https://github.com/gluax)
+   - [Meshiest](https://github.com/Meshiest)
+   - [voximity](https://github.com/voximity)