Skip to content

Commit bede176

Browse files
committed
touchups
1 parent 256314a commit bede176

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Distributed documentation tooling for a distributed company.
66

77
This repository is host to:
88

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
1010
* *`docs-assembler`* command line tool to assemble all the doc sets.
1111

12+
Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
13+
1214
## Distributed documentation
1315

1416
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
2224
This allows us to:
2325

2426
* 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.
2730

2831

29-
## Installation
32+
## Installation
3033

3134
### Linux / OSX
3235
```bash

0 commit comments

Comments
 (0)