3 ms·
> Docs as code is a methodology where the tools you use for writing documentation are the same as the tools used for writing software. This includes: Using
by kodah 3y ago
> Docs as code is a methodology where the tools you use for writing documentation are the same as the tools used for writing software. This includes:
Using version control software
Writing plain-text documentation files
Running automated tests
Practicing continuous integration and continuous delivery
To me this is version controlled and tested docs. There's little code to it from what I can see. Docs as code is like in Go where you annotate a function and it's documentation is rendered into markdown. Some of these systems can be rigged up to be quite fancy, like generating OpenAPI specs from annotations and signatures.
It is still cool to see what goes into managing a knowledge base of that size and scale. I'd be interested in what they use as front matter structure to organize everything.
- remoquete 3y agoAgain, the point is not to write code to write docs. See the other comments.
- kodah 3y agoThat would also be the point of what I described. You're not writing code, you're writing comments. Those comments are consumed by a structured static site generator. What linode does has nothing to do with code other than using a markdown linter and a pipeline.
- remoquete 3y agoOf course docs are code. The fact that English still doesn't have a compiler to machine code doesn't mean it won't move registers in your brain. There's already a pretty good interpreter in our heads and it's called Wernicke's area. ;-)