You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,11 @@ Distributed documentation tooling for a distributed company.
6
6
7
7
This repository is host to:
8
8
9
-
**`docs-builder`* command line tool to generate single doc-sets (native code, no dependencies)
9
+
**`docs-builder`* command line tool to generate single doc-sets
10
10
**`docs-assembler`* command line tool to assemble all the doc sets.
11
11
12
+
Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
13
+
12
14
## Distributed documentation
13
15
14
16
The main driver for folks writing documentation is `docs-builder`.
@@ -22,11 +24,12 @@ The `docs-assembler` tool then assembles all the repositories in the [link-regis
22
24
This allows us to:
23
25
24
26
* Validate outbound and inbound links ahead of time during `docs-builder` builds.
25
-
* Documentation errors in one repository won't affect all the others.
26
-
* Since we only build commits that have produced a `links.json` file the assembler is resilient to repositories having build failures on their integration branches.
27
+
* Snapshot builds: only building commits that produced a `links.json`
28
+
* Documentation errors in one repository won't affect all the others.
29
+
* Resilient to repositories having build failures on their integration branches, we fall back to the last known good commit.
0 commit comments