Skip to content

Commit

Permalink
adding a little more detail about the workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
liampaull authored Dec 3, 2018
1 parent 154a498 commit b5e2ab5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion book/duckumentation/10_contributing/41_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ Check out the forked repository as you would do normally.

### Initialize your folder

Go into the folder:

$ cd docs-![book]


When compiling a book for the first time, you need to run:

$ git submodule init
Expand All @@ -56,7 +61,7 @@ And:

### Do your edits

Do your edits on your local copy.
Do your edits on your local copy. The source files are in the director `book/![book]`. The file and folder names start with numbers, these are used to determine the order that things show up in output.

### Compile

Expand All @@ -69,6 +74,11 @@ Re-compile from scratch using:
$ dts docs clean
$ dts docs build

If there are errors you should open `duckuments-dist/errors.html` and look at them and fix them.

### Look at the local copy

Open the file `index.html` and navigate to whichever pages you have changed to make sure that they look the way want them to.

### Commit and push

Expand Down

0 comments on commit b5e2ab5

Please sign in to comment.