d33p.jsI'm considering improving our development documentation. We used Notion, but it wasn't very effective. As a wiki or knowledge store, it was simply too expensive. We switched to Slack Canvas, which feels clunky.
However, I had an idea: why not use a docs directory in our source code folder to structure our knowledge base in markdown files?
Perhaps we could use Jekyll or Docusaurus to create an internal website through a CI/CD pipeline? Or, we could even use our Git repository as a markdown viewer, including its search functionality.
Has anyone tried something similar? Are there any significant drawbacks? I want our developers to have the most straightforward experience possible. Occasionally, Notion felt overly complex and cumbersome to use. Additionally, a mediawiki, bookstack, or Wiki.js doesn't seem like the ideal solution, too.
Using markdown files in a structured folder structure appears to be an straightforward approach with a low threshold for adding or updating documentation.
Do I miss something?
#wiki #knowledge #knowledgebase #jekyll #dev #development #documentation #docusaurus #github
Marc van Andel
J Simon van der Walt
Ampache
CloudNativePG
Juhis
Nicolas Fränkel 🇪🇺🇺🇦🇬🇪
Winbuzzer
Honza Javorek
Sanjay Viswanathan