Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 1.9 KB

README.md

File metadata and controls

86 lines (62 loc) · 1.9 KB
Raw

Strata - Public Docs

This repository contains all public devnet documentation related to Strata.

Getting Started

  1. Clone this repository:

    git clone https://github.com/alpenlabs/docs.git

  2. Install required dependencies.

    wget -qO- https://get.pnpm.io/install.sh | sh - # install pnpm
pnpm install

  3. Install mkdocs-material:

    pip install mkdocs-material

Note

Alternatively you can use the mkdocs-material Docker image:

docker pull squidfunk/mkdocs-material

Alternatively you can use the pyproject.toml Poetry environment:

poetry install --no-root

Making Changes

You can add your changes by editing/creating the markdown files in the appropriate location in the repository. Make sure that you adhere to our style guide.

To preview your changes, run the following command:

mkdocs serve

Note

If you are using the Docker image, you can run the following command:

docker run --rm -u "$(id -u):$(id -g)" -v "$PWD":/docs -p 8000:8000 squidfunk/mkdocs-material

Your preview should be available at http://localhost:8000.

Contributing

Before you push any changes or create a PR, please run the following:

# check that everything is formatted correctly
pnpm format:check

# check that there are no spelling errors
pnpm spell:check

# check that all documents follow the markdownlint rules
pnpm lint:check

Errors in any of the above commands will cause the CI to fail. Formatting and lint issues can be fixed with the following:

pnpm format:fix

pnpm lint:fix

It is best to let your editor help you with these things so that you are not caught by surprise when the CI checks run. This repo includes settings for vscode that will help you get feedback from your editor as early as possible.