diff --git a/content/en/docs/edp/documentationsystem.md b/content/en/docs/edp/documentationsystem.md index 919a12c..1d8a337 100644 --- a/content/en/docs/edp/documentationsystem.md +++ b/content/en/docs/edp/documentationsystem.md @@ -2,9 +2,30 @@ title: "Documentation System" linkTitle: "Documentation System" weight: 100 -description: The developer 'documentation as code' documentation System we use ourselfes and over to use for each development team. +description: This documentation system, built on the 'documentation as code' principle, is used internally and recommended for all development teams. --- -We have a documentation system. +Embracing the powerful philosophy of **Documentation as Code**, the entire +documentation is authored and meticulously maintained as plain text Markdown +files. These files are stored within a Git repository, allowing for the +leveraging of version control to track changes, facilitate collaborative +contributions, and ensure a robust review process, much like source code. -It is in this repo: ... \ No newline at end of file +The documentation source code is hosted at +. The `README` +files within this repository provide detailed instructions on how to contribute +to and build the documentation. It is primarily powered by +[Hugo](https://gohugo.io/), a fast and flexible static site generator, which +transforms the Markdown content into a production-ready website. To enhance +clarity and understanding, sophisticated diagramming tools are integrated: +[Mermaid.js](https://mermaid.js.org/) for creating dynamic charts and diagrams +from text, and [LikeC4](https://likec4.dev/) for generating C4 model +architecture diagrams directly within the documentation. + +Changes pushed to the `main` branch of the repository automatically trigger the +continuous integration and deployment (CI/CD) pipeline. This process is +orchestrated using [Forgejo Actions](/docs/edp/forgejo/actions/), which +automates the build of the static site. Subsequently, the updated documentation +is automatically deployed to . This streamlined +workflow guarantees that the documentation is always current, accurately +reflecting the latest system state, and readily accessible to all stakeholders.