Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.34 KB

DOCS.md

File metadata and controls

38 lines (23 loc) · 1.34 KB
Raw

Documentation

The Kurtosis docs are live on the Polygon Knowledge Layer here.

Follow the steps below to run the Kurtosis docs locally.

Run docs locally

Prerequisites

  1. Python 3.12.
  2. virtualenv: Install using pip3 install virtualenv.

Setup

  1. Clone the repository.
  2. cd to the root.
  3. Run the scripts/serve_docs.sh script. You may need to make the script executable: chmod +x scripts/serve_docs.sh
sh scripts/serve_docs.sh

The site comes up at http://127.0.0.1:8000/

Style guide

We are using the Microsoft Style Guide.

Contributing

  1. Add your doc to the docs folder and add a menu item in the mkdocs.yml file.
  2. Raise a ticket on the docs team slack channel, or JIRA board to let us know, and we'll review it and approve.

Contact

  • For technical issues, join our Discord.
  • For documentation issues, raise an issue on the published live doc at our main repo.