Skip to content

README.md

Latest commit

 

History

History
132 lines (85 loc) · 2.26 KB

README.md

File metadata and controls

132 lines (85 loc) · 2.26 KB

Docs-as-Code Toolkit

Docs-as-Code

docs-as-code-toolkit-logo

Part of the Docs-as-Code Toolkit
→ https://github.com/docs-as-code-toolkit

Build documentation like software.

Versioned. Reproducible. Automated.

🎯 What this is

This is not just a collection of repositories.

It’s a complete Docs-as-Code ecosystem that helps you:

  • eliminate "works on my machine"
  • unify local and CI environments
  • structure and connect architecture documentation
  • treat documentation as a first-class artifact

🧩 The Toolkit

🔧 Infrastructure

docs-toolbox A Docker image with everything you need:

  • Asciidoctor
  • Pandoc
  • Graphviz
  • ...

👉 Run the same environment locally and in CI.

🎨 Presentation

asciidoc-style (coming soon) Reusable styling for:

  • architecture documentation
  • websites
  • CVs

🧠 Automation

doc-generators (planned) Generate dynamic documentation:

  • cross-links
  • traceability
  • architecture views

🌐 Example / Showcase

profile Real-world usage of the toolkit:

  • personal website
  • CV generation
  • architecture documentation

👉 Profile of Dieter Baier.

🧭 Philosophy

Write once. Publish everywhere.

Documentation should be:

  • ✔ versioned
  • ✔ testable
  • ✔ reproducible
  • ✔ automatable

🚀 Getting started

Run your documentation build inside a reproducible environment:

docker run --rm \
  -v $(pwd):/app \
  -w /app \
  ghcr.io/docs-as-code-toolkit/docs-toolbox:latest \
  asciidoctor -v

💬 Discussions

Have questions, ideas, or feedback?

👉 Use the Discussions tab to:

  • ask questions
  • share ideas
  • show how you use the toolkit

🤝 Why this matters

Documentation is often:

  • outdated
  • inconsistent
  • hard to maintain

This approach turns it into something that actually scales.

👤 Author

Created by Dieter Baier Software Architect · Docs-as-Code enthusiast