Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

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

It operates one layer above publishing: source documents, metadata, relations, and review workflows remain the authoritative knowledge base; generated documentation is a derived artifact. It can also be rendered and published by docToolchain or similar tools, while this project's docs-toolbox provides the necessary tools for local and CI-based rendering as well.


🧩 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

architecture-knowledge-toolkit Reusable architecture knowledge structures:

  • semantic contracts
  • metadata conventions
  • artifact templates
  • traceability relations
  • review workflows
  • AI-assistable skills

👉 Structure, relate, review, and evolve architecture knowledge.


doc-generators (planned) Generate dynamic documentation:

  • cross-links
  • traceability
  • architecture views

Relationship to docToolchain

This project is not intended to compete with docToolchain.

docToolchain is a mature Docs-as-Code toolchain for building, converting, publishing, and integrating technical and software architecture documentation. The Docs-as-Code Toolkit focuses on the layer above publishing: reproducible source workflows, structured architecture knowledge, metadata, traceability, reviewability, and automation-friendly conventions.

Both approaches can be combined. This toolkit can provide structured AsciiDoc sources and metadata, while docToolchain or similar tools render and publish the resulting documentation.


🌐 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

About

The Docs-as-Code Toolkit — an ecosystem for building versioned, reproducible, and automated documentation.

Topics

Resources

Stars

Watchers

Forks

Contributors