A source-agnostic GitHub Action that renders one living-doc-toolkit output as one plain Markdown document, with a
run report. It is the generate step of a living-documentation pipeline, the final stage, after living-doc-toolkit.
- Three document types: a technical project, a UI test catalog and a coverage matrix, each from the one
living-doc-toolkitoutput it reads → Document types - By view: a document shows what the view its input declares,
innerorrelease, keeps → Document types - Two files per run, the document and its run report, into
output-path→ Files - Plain Markdown, meant to be committed next to the code it documents and rendered by whatever already renders the repository's Markdown (GitHub, a wiki, a generic static site generator), so no publishing infrastructure is needed
- Contract artifacts only: it reads its input through the
living-doc-utilitiescontracts (==0.8.1) → Contracts - Pipeline-ready: collect → normalize → generate, this action being the generate step → Architecture, Choose a generator
- GitHub Actions first: a step in a workflow is the supported way to run it; a local run is a development and operator-check aid, not a second deployment target → Debug run, Local Integration Run
- AI-free: collect → normalize → generate is deterministic tooling, with no LLM call anywhere in that path → AI-free Principle
- The tooling is Python, JSON Schema validation, and Jinja2 and Markdown templates.
- The agentic layer in
living-docagentic/can speed up authoring GitHub Issues and.featurefiles. - It is never a runtime dependency: a human writing the same input by hand is a fully supported, identical path.
One step that renders a technical project, after actions/setup-python
(Prerequisites):
- name: Generate Markdown
id: markdown
uses: AbsaOSS/living-doc-generator-markdown@v0.1.0
with:
document-type: technical-project
source-path: generator-ready.json
output-path: docs/generated
document-title: Payments serviceThe three document types: Document types. What lands in output-path, and how a
later step reads it: Files, Outputs.
Every input at a glance; required flags, defaults and errors are in the action reference.
document-type(required):technical-project,ui-test-catalogorcoverage-matrixsource-path(required): the document type's input fileoutput-path: the directory the document and its run report go intodocument-title: the document's titleverbose-logging: debug logging
The one output, output-path, is that directory as an absolute path (Outputs).
| I want to… | Read |
|---|---|
| set every input, pick a document type, read the files and the output, handle an error | Action reference |
| know which fields each view shows | living-doc-utilities rendering rules |
| read the contracts and codes the generator implements | living-doc-utilities contracts |
| see where the generator sits in the pipeline | The frame |
render one document from samples, or all three from a living-doc-toolkit run's files, outside any workflow |
Debug run, Local Integration Run |
| set up the repository, run the gates, read the design rules | Developer guide |
| contribute a change | Contributing |
Setup, the gates, the design rules, the local runs, the action's venv, CI and the page rules: DEVELOPER.md.
Contributions are welcome. Bug reports, feature requests, the AI-free principle, and branch and pull request conventions: CONTRIBUTING.md.
Licensed under the Apache License 2.0; see LICENSE.
Maintained by ABSA Group Limited. Open a GitHub Issue for questions, bug reports, or feature requests.