We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 78d308f commit 4dde728Copy full SHA for 4dde728
1 file changed
docs/README.md
@@ -13,4 +13,18 @@ Another way to do local development without doing the Ruby setup steps is to use
13
14
```sh
15
$ docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
16
-```
+```
17
+
18
+# Authroing the docsite
19
20
+The docsite is a mix of stardoc generated markdown and hand written markdown.
21
+The files marked with
22
23
+<!-- *********************
24
+ DO NOT EDIT THIS FILE
25
+ It is a generated build output from Stardoc.
26
+ Instead you must edit the .bzl file where the rules are declared,
27
+ or possibly a markdown file next to the .bzl file
28
+ ********************* -->
29
+ ```
30
+ Should be edited by modifying the docs in the source `.bzl` files, other files can be freely edited.
0 commit comments