Caido

Contributing to the Documentation ​

Caido's documentation is open source and is open to community member contributions.

INFO

You will need a Github account, Git, and the pnpm package manager.

Creating a Workspace ​

To contribute to the documentation, first fork the repository and create a clone.

git clone https://github.com/<username>/documentation

Then, navigate into the directory and create a new branch.

cd documenation && git branch -b <branch-name>

Style Guidelines ​

  • Pages are primarily written in Markdown, although HTML can be used as well.
  • Ensure to always link pages in the correct sidebar by editing the .vitepress/sidebars file.
  • Button icons are sourced from the FontAwesome Classic Solid collection.

TIP

To serve the documentation locally and view edits live run pnpm dev.

Publishing ​

When you are finished editing, commit the changes and push them to your fork.

git add . && git commit -m "<description>" && git push

Then, open a pull request on the documentation repository.

INFO

To contribute, you must sign the Contributor License Agreement which will be available as a link within the pull request.

Your pull request will await and undergo review. You will be notified of any requested changes and its status. Once the changes are merged, you work will appear in the official documentation.