Skip to content

Commit

Permalink
edits: reverted changes and readded contributing file in docs repo
Browse files Browse the repository at this point in the history
  • Loading branch information
FelixNicolaeBucsa committed Jun 27, 2024
1 parent 4e36f59 commit 49c2a1e
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Documentation Setup

## Prerequisites

Make sure that you have pipenv installed on your system:

pip3 install pipenv

Once installed navigate to this folder in the project

cd fetchd/docs

Make sure all the dependencies are installed

pipenv install -d

## Updating the docs

Once the dependencies are setup you must activate the environment with the following commands

pipenv shell

This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path

which mkdocs

Finally, to start the development server run the following command

mkdocs serve

This will listen for changes on the filesystem and automatically update the documentation.

0 comments on commit 49c2a1e

Please sign in to comment.