Skip to content

Commit

Permalink
A note about redirects.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
emirotin authored Aug 30, 2016
1 parent 881a621 commit 8b36222
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,14 @@ Now you can make changes in this branch. Since our docs are static pages generat
```
./tools/prepare.sh
```
However there is a handy watch functionality that will watch for changes in `/pages` and rebuild each time you save your changes. To use this, open a new tab in you terminal and run:
However there is a handy watch functionality that will watch for changes in `/pages`, `/shared`, and `/templates` and rebuild each time you save your changes. To use this, open a new tab in you terminal and run:
```
npm run watch-pages
```
Once you are happy with your changes, submit a pull request for you branch against `master`.

_Note_ that you have to restart the development server if you edit other things like `redirects.txt`.

### Using Partials

When creating new content or altering current pages, its recommended that you try keep things D.R.Y (Don’t Repeat Yourself). This is made easy by using “partials”. If you look in the `/shared` folder you will see a number of folders, these keep snippets or partials of the docs that can be reused all over the place. They also allow you to cleverly override a partial for a particular board type and language type. So in general you will see most of them just contain a `_default.md` which means that this partial will be used for all board and language types, but for partials like `getDeviceOnDash` we have device specific overrides.
Expand Down

0 comments on commit 8b36222

Please sign in to comment.