DocsGenerator

Generates human-readable Markdown documentation for a project.

The HTML report is for exploring; this is for reading, committing, and reviewing. Markdown renders on GitHub without a build step, diffs line by line in a pull request, and can be opened by anyone without running Gradle - so an architecture change shows up in review as a text diff next to the code that caused it.

Everything is assembled from the same deterministic findings the report uses, so re-running on an unchanged project produces byte-identical files. That is the property that makes committing the output safe: a diff means the architecture changed, never that the tool ran again.

Functions

Link copied to clipboard

Generates the full document set, keyed by file name relative to the docs output directory.