31 lines
1.8 KiB
Markdown
31 lines
1.8 KiB
Markdown
---
|
|
title: "Documentation System"
|
|
linkTitle: "Documentation System"
|
|
weight: 100
|
|
description: This documentation system, built on the 'documentation as code' principle, is used internally and recommended for all development teams.
|
|
---
|
|
|
|
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.
|
|
|
|
The documentation source code is hosted at
|
|
<https://edp.buildth.ing/DevFW-CICD/website-and-documentation>. 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 <https://docs.edp.buildth.ing/>. This streamlined
|
|
workflow guarantees that the documentation is always current, accurately
|
|
reflecting the latest system state, and readily accessible to all stakeholders.
|