Skip to content

Documentation with mkdocs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documentation with mkdocs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# MerkleBot Storage

A RESTful API for storing files in web3 storage networks.
3 changes: 3 additions & 0 deletions docs/job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Job

Job resource represents heavy operation order like an encryption or decryption. Implementation is incomplete yet and not ready for usage.
6 changes: 6 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
site_name: MerkleBot Storage
repo_name: merklebot/storage
repo_url: https://github.com/merklebot/storage
nav:
- MerkleBot Storage: index.md
- Job: job.md
Loading