Requires manual escaping - constantly over- or under-escaping. Really kicked off the static site generator revolution.In my opinion, g3doc has successfully platformized the generic parts of technical documentation, enabling engineers to focus on the important part: writing content and making a legible information hierarchy.ĭocsy was started by the g3doc team, who are trying to create an excellent open-source documentation platform. I have experience at work with g3doc, Google's hosted internal technical documentation platform SRECon Talk, Slides. In a previous post, I evaluated many open source documentation solutions. Page feedback - 'was this page useful / how could we improve it' surveys (we're not using this yet)Īnd Docsy is under active development: hopefully we will be able to benefit from yet more features in future.Anchor-links to page headings for easy sharing of specific sectionsĪnd some features we're not using yet, but are interested in exploring:.'File a docs issue with this page' links.These are critical for lowering the bar for 'drive-by' small fixes from anyone, and growing contributors. 'Edit this page' links that drop you straight into an editor to make a pull request.An information hierarchy (top-level tabs at the topbar, doc hierarchy on the left-nav, and jump-to-headings on the right-hand-nav).A beautiful theme, particularly for code samples (the old Graphviz site had very little CSS).I wanted to outsource the generic parts of technical documenation: Graphviz has only a handful of spare-time contributors, so we have time to spend on reinventing solved problems. Mostly, I wanted access to the Docsy technical documentation theme, which is written for Hugo. Tens of thousands of developers use Graphviz, so hopefully improving the docs will have some leverage. I get a lot of value out of Graphviz, but I felt it was hard to convince other people to use Graphviz because it's documentation was very hard to navigate. I regularly use Graphviz to diagram distributed system components at work. Graphviz is an open source project for visualising nodes and edges connecting them. Old and New Responsive Design Improving the docs

Gem install jekyll missing binary