Tag: Documentation

How to Write Good Documentation with Docsify

Documentation is critical to a successful product. Without documentation, it’s more difficult for people to use your product, and it’s just as important if you’re running an open-source project, too. Creating a documentation site can be challenging, especially if you’re not familiar with front-end development. I have been a ...
Continue Reading How to Write Good Documentation with Docsify

How to Create Diagrams as Code with Mermaid, GitHub, and Visual Studio Code

Diagrams are an important part of technical documentation. In this article we will explore how we can use code to generate diagrams and leverage them in Markdown. Here is an example of how a code generated diagram looks like: Diagram generated by codeNo tools, no dragging, aligning and snapping ...
Continue Reading How to Create Diagrams as Code with Mermaid, GitHub, and Visual Studio Code