Skip to main content

Automating Documentation: From DSL to Dynamic Docs with Asciidoctor and Antora

UD2.208 (Decroly) | Day 1 | 17:00 - 17:25 | Speakers: Ivan Ponomarev

Automating Documentation: From DSL to Dynamic Docs with Asciidoctor and Antora
A picture of a devroom at FOSDEM 2024
Open in browser

Notes

Abstract

Documentation often lags behind code changes, leading to inconsistencies and outdated information. This session explores how to automate the generation of comprehensive and up-to-date documentation using a custom Yaml-based domain-specific language alongside Asciidoctor and Antora. By defining product behavior in a DSL, we not only produce the framework for software code but also generate the bulk of the documentation, making the DSL the single source of truth for the project. We'll discuss the power of this approach in keeping documentation aligned with the codebase and also demonstrate how to test code snippets within your documentation. Learn how this practice prevents broken examples and leverages Asciidoctor's capabilities to ensure your documentation remains reliable and accurate.


Notice: The placeholder video image is licensed under CC BY-SA 4.0. The original image can be found hereChanges made to the image are: Cropped the image to a new ratio, part of the image was cut off.