https://github.com/jackallabs/book
https://github.com/jackallabs/book
cloud-storage cosmos docs documentation jackal
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jackallabs/book
- Owner: JackalLabs
- Created: 2024-07-03T01:55:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T15:32:05.000Z (about 1 year ago)
- Last Synced: 2025-04-28T16:27:41.725Z (about 1 year ago)
- Topics: cloud-storage, cosmos, docs, documentation, jackal
- Homepage: https://docs.jackalprotocol.com/
- Size: 519 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
## Welcome to the Jackal Docs
Welcome, to the Jackal Documentation, where you'll embark on a journey to discover a more secure, simple, and self-custodial digital world. It doesn't matter if you are here to learn more about the protocol, develop novel applications using Jackal storage or are just poking around, you're sure to find exactly what you need.
### Contributing
In order to keep these docs up to date, they are open-source and hosted on GitHub. This means that if you find information that is out of date, or lacking in substance, you can submit edits of your own.
{% hint style="warning" %}
All edits undergo a review process by the Jackal Labs team before being reflected here.
{% endhint %}
Start by cloning the Jackal Book GitHub repo.
```shell
git clone https://github.com/JackalLabs/book.git
```
From there, you can edit any of the `.md` files, and add new ones to edit/create pages in the book.
To test your edits, download [Docute!](https://github.com/TheMarstonConnell/docute). You can install it by running:
```shell
go install github.com/TheMarstonConnell/docute@latest
```
From here, you can test your changes by running the following commands and going to [localhost:9797](http://localhost:9797).
```shell
cd book
docute generate
docute host
```
If you want more information about Docute, the documentation engine this site uses, check out the [Docute docs](https://jackallabs.github.io/docute/).
#### Side Bar
`SUMMARY.md` is a markdown representation of the side navigation bar which is compiled onto every page. Making changes here will change how you navigate through the book itself. Remember, any time you add a page, it is a good idea to add it to the sidebar to make it accessible unless you specifically want to nest it within other pages.