Skip to content

Documentation

📄 Documentation

These steps will help you get started with contributing to the NSDF Dark Matter documentation

Virtual Environment

At the root of the project, you can create a new virtual environment with the following command:

uv venv docs_env --python 3.10

Activating the Environment

Activate the environment with the following command:

source docs_env/bin/activate

Installing Dependencies

You will need to install the following dependencies to develop locally:

uv pip install mkdocs mkdocs-material

Developing Code

Now that you have the environment activated, you are ready to contribute code to the documentation. A typical development workflow might look like this.

  1. Spin up the documentation page locally by running mkdocs serve.
  2. Implement your documentation changes following the structure of the project. All of the project documentation is under the docs directory. Make sure to put assets in the respective directory under docs/assets. For adding gifs see creating gifs.
  3. Follow all the other steps starting from Opening a Pull Request.

Creating gifs

Gifs in the documentation are generated by the fantastic vhs library from Charm Bracelet. To add a new gif document the .tape script in the docs/assets/tapes folder and then add the gif artifact to the appropriate folder.