© 2022 Hashnode
#documentation
Introduction: This article explains about writing technical documentation using Mkdocs, installation, update and deployment on production. Installation: Follow these steps to setup Mkdocs on your loca…
Knowing what to do and when is the key to systems and teams that perform well, and getting to that point requires a shared understanding of how all the pieces work together. As I mentioned in the last post having a logical basis for system…
Paying for Slack to store old messages is a waste of money. Key Tips To Building a Knowledge Base Develop documentation culture. Use documentation tools like Notion instead of instant messengers lik…
Introduction I use any dev tools or library on the basis of its documentation. I use their documentation to know about the tools and how to integrate them into different setups. If the documentation i…
What is a CONOPS (Concept of Operations)? TLDR: Back of a napkin system plan. A document, that proposes the characteristics and attributes of a system required to solve a current or emerging problem. It describes in carefully abstract ter…
Introduction In this tutorial, I will create a documentation project on Read the Docs by importing a Sphinx project from a GitHub repository and exploring several useful features of the platform. The …
More and more technical writers want to share their journey and knowledge. The good thing is, sharing is caring. Yet, some of us struggle with: What to write about What platform to document, and What…
Context I had trouble getting showLastUpdateAuthor and showLastUpdateTime to display in production build when deploying through Gitlab CI. Before I show you how to fix it, let's see what this feature …
Background 💭 I am working on a blog on the concepts of Open API Specification, where I came across Swagger UI and Swagger Editor. I needed these two tools on my machine so that I could make my hands …
Technical writing is a type of writing that explains complex, technical and specialized information in easily digested bits to people who may or may not have experience with the information. Examples…
![[Docusaurus] How to enable showLastUpdate feature when deployed via Gitlab CI](/_next/image?url=https%3A%2F%2Fcdn.hashnode.com%2Fres%2Fhashnode%2Fimage%2Fupload%2Fv1667638183594%2FD40u-fAkz.png%3Fw%3D1600%26h%3D840%26fit%3Dcrop%26crop%3Dentropy%26auto%3Dcompress%2Cformat%26format%3Dwebp&w=3840&q=75)
