DevFW-CICD/website-and-documentation
23
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): Added some text describing the documentation itself
Some checks failed
build / build (push) Failing after 56s
Details
ci / build (push) Successful in 57s
Details

Browse source
This commit is contained in:
Patrick Sy 2025-12-18 14:57:53 +01:00
parent ad0052c0a7
commit 610e7d2767
Signed by: Patrick.Sy
GPG key ID: DDDC8EC51823195E
1 changed files with 24 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

27
content/en/docs/edp/documentationsystem.md
View file

@ -2,9 +2,30 @@
title: "Documentation System" title: "Documentation System"
linkTitle: "Documentation System" linkTitle: "Documentation System"
weight: 100 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: ... 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.