Skip to content

Commit

Permalink
Merge pull request #88 from TypedDevs/docs-set-up-in-contributing
Browse files Browse the repository at this point in the history
Add docs setup  in CONTRIBUTING.md
  • Loading branch information
antonio-gg-dev authored Sep 15, 2023
2 parents c3f9755 + 146ec03 commit 8e5e050
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,18 @@ Please post code and output as text ([using proper markup](https://guides.github
5. Ensure the code complies with our coding guidelines (see below).
6. Send that pull request!

Please make sure you have [set up your username and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name <root@localhost>` look really stupid in the commit history of a project.
Please make sure you have [set up your username and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name <root@localhost>` looks bad in the commit history of a project.

## Specific set up for documentation application

Our documentation is build with [VitePress](https://vitepress.dev/), for set up a local environment to contribute follow these steps:
1. You'll need `node`(_we recommend using [nvm](https://github.com/nvm-sh/nvm)_) and `yarn` for set up the environment.
* Using `nvm` you can execute `nvm use`(reads _.nvmrc_ file) in the project root directory and follow the instructions to use the correct `node` version.
* To install `yarn` you can use `npm i -g yarn`.
2. Install dependencies with `yarn install`.
3. Run local development server with `yarn docs:dev`.
4. Implement your changes.
5. Before submitting your Pull Request run `docs:build` to ensure everything works.

## Change the configuration
To change the configuration for the project we use the `.env` file if you would like to know what variables should be there use the following command:
Expand Down

0 comments on commit 8e5e050

Please sign in to comment.