Story Documentation

This repository contains the official documentation for Story, a purpose-built layer 1 blockchain designed specifically for intellectual property.

📚 Official Documentation

Proposing Changes

If you see any issues with the docs or would like to add/modify them, please open a Pull Request and tag @jacob-tucker :)

Train AI on our Docs

If you want to train an AI on our docs, you can use the combined.md file. It contains all of our docs in a single .md file, and is updated automatically every time a change is made to the repo.

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of the repository (where docs.json is)

mintlify dev

Navigation Updating Script

Once you created a new page, you can use this script to add it to the navigation structure in the docs.json file.

Usage

Run it from the root folder.

python add_it.py <path/to/file.mdx>

Examples

# Addin the `multisig` page to the `network/more` section
python add_it.py network/more/multisig.mdx

Supports .md and .mdx files. Run from directory containing docs.json.

Troubleshooting

• Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
• Page loads as a 404 - Make sure you are running in a folder with docs.json
• Add It script not working? Is Python 3 Installed? Is the path correct? Still not working? Please report an issue