maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update the docs readme with instructions [ci skip] (#4361)

Browse source 
The readme should include instructions to run the docs site so that
people don't have to go searching for the contributing.md file if they
are stumbling upon the docs in their code editor instead of via the
docs.dev.to website.
This commit is contained in:
Jacob Herrington 2019-10-14 08:24:46 -05:00 • committed by Ben Halpern
parent 296ebeba6b
commit 691faf78ac
2 changed files with 34 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/contributing.md
View file

@ -16,7 +16,7 @@ For more information on how to use GitDocs read the [GitDocs guide](https://gitd
## Running the Docs Locally
Install the [GitDocs NodeJs library](https://www.npmjs.com/package/gitdocs)
Install the [GitDocs NodeJS library](https://www.npmjs.com/package/gitdocs):
```shell
npm install gitdocs -g
@ -30,8 +30,7 @@ If you use yarn you can instead issue:
yarn global add gitdocs
```
Once installed, to run gitdocs you need to navigate to the root
directory of the DEV.to codebase and run
Once installed, you can run `gitdocs serve` from the root of the dev.to project or from the `/docs` directory.
```shell
gitdocs serve

32
docs/readme.md
View file

@ -17,3 +17,35 @@ items:
# Welcome to DEV's developer documentation
Here you can find instructions on how to setup your own local copy of DEV, how to navigate the code, how to contribute, and how to troubleshoot issues, among other things.
# Running the documentation locally
DEV's documentation is built with [GitDocs NodeJS library](https://www.npmjs.com/package/gitdocs).
The first step to running the documentations it locally is to install the `GitDocs` package globally.
With npm:
```shell
npm install gitdocs -g
```
Alternatively, you can use Yarn:
```shell
yarn global add gitdocs
```
Once installed, you can run `gitdocs serve` from the root of the dev.to project or from the `/docs` directory.
```shell
gitdocs serve
```
This will start a server where you can browse the documentation: <http://localhost:8000/>
When you add new markdown pages or rename existing ones, you'll have to restart
the server before you notice any changes.
# Contributing to the docs
If you're looking for more information on contributing, check out the [Contributing article](https://docs.dev.to/contributing/).