Skip to content

Commit

Permalink
feat(docs): add authroing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabian Wiles authored and alexeagle committed Feb 12, 2020
1 parent 78d308f commit 4dde728
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,18 @@ Another way to do local development without doing the Ruby setup steps is to use

```sh
$ docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
```
```

# Authroing the docsite

The docsite is a mix of stardoc generated markdown and hand written markdown.
The files marked with
```
<!-- *********************
DO NOT EDIT THIS FILE
It is a generated build output from Stardoc.
Instead you must edit the .bzl file where the rules are declared,
or possibly a markdown file next to the .bzl file
********************* -->
```
Should be edited by modifying the docs in the source `.bzl` files, other files can be freely edited.

0 comments on commit 4dde728

Please sign in to comment.