docs(docs): code quality metrics with 5 supporting modules

stats:
  lines: "+17/-17 (net +0)"
  files: 4
  complexity: "Stable complexity"

Author: tom-sapletta-com

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.8] - 2026-03-07
+
+### Docs
+- Update code2docs/README.md
+- Update code2docs/docs/api.md
+- Update code2docs/docs/architecture.md
+- Update code2docs/docs/modules.md
+
 ## [0.2.7] - 2026-03-07
 
 ### Docs

README.md

@@ -1,6 +1,6 @@
 # code2docs
 
-![version](https://img.shields.io/badge/version-0.2.7-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
+![version](https://img.shields.io/badge/version-0.2.8-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
 
 > Auto-generate and sync project documentation from source code analysis.
 
@@ -140,7 +140,7 @@ code2docs can update only specific sections of an existing README using markers:
 ```markdown
 <!-- code2docs:start --># code2docs
 
-![version](https://img.shields.io/badge/version-0.2.7-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey) ![functions](https://img.shields.io/badge/functions-153-green)
+![version](https://img.shields.io/badge/version-0.2.8-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey) ![functions](https://img.shields.io/badge/functions-153-green)
 > **153** functions | **30** classes | **28** files | CC̄ = 0.0
 
 ## Installation

VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

code2docs/README.md

@@ -5,8 +5,8 @@
 
 > Auto-generated project documentation from source code analysis.
 
-**Author:** Tom Softreck <tom@sapletta.com>  
-**License:** MIT[(LICENSE)](./LICENSE)  
+**Author:** Tom Sapletta  
+**License:** Apache-2.0[(LICENSE)](./LICENSE)  
 **Repository:** [https://github.com/wronai/code2docs](https://github.com/wronai/code2docs)
 
 ## Installation
@@ -141,7 +141,7 @@ Content outside the markers is preserved when regenerating. Enable this with `sy
 
 ```
 code2docs/
-├── registry├── llm_helper├── code2docs/    ├── updater├── sync/    ├── watcher    ├── differ    ├── quickstart    ├── advanced_usage    ├── markdown    ├── badges    ├── toc├── formatters/    ├── readme_gen├── base    ├── coverage_gen    ├── _source_links    ├── depgraph_gen    ├── getting_started_gen    ├── config_docs_gen    ├── changelog_gen├── generators/    ├── module_docs_gen    ├── api_reference_gen    ├── mkdocs_gen    ├── examples_gen    ├── _registry_adapters├── cli    ├── api_changelog_gen    ├── contributing_gen├── analyzers/    ├── architecture_gen├── config    ├── project_scanner    ├── dependency_scanner    ├── endpoint_detector    ├── docstring_extractor```
+├── registry├── llm_helper├── code2docs/    ├── updater├── sync/    ├── watcher    ├── differ    ├── quickstart    ├── advanced_usage    ├── markdown    ├── badges    ├── toc├── formatters/├── base    ├── readme_gen    ├── _source_links    ├── coverage_gen    ├── getting_started_gen    ├── depgraph_gen    ├── config_docs_gen├── generators/    ├── changelog_gen    ├── api_reference_gen    ├── module_docs_gen    ├── mkdocs_gen    ├── _registry_adapters    ├── examples_gen    ├── api_changelog_gen    ├── architecture_gen    ├── contributing_gen├── analyzers/├── cli├── config    ├── project_scanner    ├── dependency_scanner    ├── docstring_extractor    ├── endpoint_detector```
 
 ## API Overview
 
@@ -153,20 +153,19 @@ code2docs/
 - **`ChangeInfo`** — Describes a detected change.
 - **`Differ`** — Detect changes between current source and previous state.
 - **`MarkdownFormatter`** — Helper for constructing Markdown documents.
-- **`ReadmeGenerator`** — Generate README.md from AnalysisResult.
 - **`GenerateContext`** — Shared context passed to all generators during a run.
 - **`BaseGenerator`** — Abstract base for all documentation generators.
-- **`CoverageGenerator`** — Generate docs/coverage.md — docstring coverage report.
+- **`ReadmeGenerator`** — Generate README.md from AnalysisResult.
 - **`SourceLinker`** — Build source-code links (relative paths + optional GitHub/GitLab URLs).
-- **`DepGraphGenerator`** — Generate docs/dependency-graph.md with Mermaid diagrams.
+- **`CoverageGenerator`** — Generate docs/coverage.md — docstring coverage report.
 - **`GettingStartedGenerator`** — Generate docs/getting-started.md from entry points and dependencies.
+- **`DepGraphGenerator`** — Generate docs/dependency-graph.md with Mermaid diagrams.
 - **`ConfigDocsGenerator`** — Generate docs/configuration.md from Code2DocsConfig dataclass.
 - **`ChangelogEntry`** — A single changelog entry.
 - **`ChangelogGenerator`** — Generate CHANGELOG.md from git log and analysis diff.
-- **`ModuleDocsGenerator`** — Generate docs/modules.md — consolidated module documentation.
 - **`ApiReferenceGenerator`** — Generate docs/api.md — consolidated API reference.
+- **`ModuleDocsGenerator`** — Generate docs/modules.md — consolidated module documentation.
 - **`MkDocsGenerator`** — Generate mkdocs.yml from the docs/ directory structure.
-- **`ExamplesGenerator`** — Generate examples/ — usage examples from public API signatures.
 - **`ReadmeGeneratorAdapter`** — —
 - **`ApiReferenceAdapter`** — —
 - **`ModuleDocsAdapter`** — —
@@ -179,11 +178,12 @@ code2docs/
 - **`GettingStartedAdapter`** — —
 - **`ConfigDocsAdapter`** — —
 - **`ContributingAdapter`** — —
-- **`DefaultGroup`** — Click Group that routes unknown subcommands to 'generate'.
+- **`ExamplesGenerator`** — Generate examples/ — usage examples from public API signatures.
 - **`ApiChange`** — A single API change between two analysis snapshots.
 - **`ApiChangelogGenerator`** — Generate API changelog by diffing current analysis with a saved snapshot.
-- **`ContributingGenerator`** — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
 - **`ArchitectureGenerator`** — Generate docs/architecture.md — architecture overview with diagrams.
+- **`ContributingGenerator`** — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
+- **`DefaultGroup`** — Click Group that routes unknown subcommands to 'generate'.
 - **`ReadmeConfig`** — Configuration for README generation.
 - **`DocsConfig`** — Configuration for docs/ generation.
 - **`ExamplesConfig`** — Configuration for examples/ generation.
@@ -194,10 +194,10 @@ code2docs/
 - **`DependencyInfo`** — Information about a project dependency.
 - **`ProjectDependencies`** — All detected project dependencies.
 - **`DependencyScanner`** — Scan and parse project dependency files.
-- **`Endpoint`** — Represents a detected web endpoint.
-- **`EndpointDetector`** — Detects web endpoints from decorator patterns in source code.
 - **`DocstringInfo`** — Parsed docstring with sections.
 - **`DocstringExtractor`** — Extract and parse docstrings from AnalysisResult.
+- **`Endpoint`** — Represents a detected web endpoint.
+- **`EndpointDetector`** — Detects web endpoints from decorator patterns in source code.
 
 ### Functions
 

code2docs/__init__.py

@@ -5,7 +5,7 @@
 README.md, API references, module docs, examples, and architecture diagrams.
 """
 
-__version__ = "0.2.7"
+__version__ = "0.2.8"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

code2docs/docs/api.md

@@ -227,7 +227,7 @@
 | Function | Signature | CC | Description | Source |
 |----------|-----------|----|-----------  |--------|
 | `generate_docs` | `generate_docs(project_path, config)` | 5 | High-level function to generate all documentation. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/__init__.py#L35) |
-| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439) |
+| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L446) |
 
 ### `llm_helper` [source](https://github.com/wronai/code2docs/blob/main/code2docs/llm_helper.py)
 
@@ -540,7 +540,7 @@
 
 | Function | Signature | CC | Description | Source |
 |----------|-----------|----|-----------  |--------|
-| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439) |
+| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L446) |
 
 ## sync
 

code2docs/docs/architecture.md

@@ -300,4 +300,4 @@ classDiagram
 | CFG Nodes | 1346 |
 | Patterns | 2 |
 | Avg Complexity | 4.0 |
-| Analysis Time | 1.92s |
+| Analysis Time | 1.76s |

code2docs/docs/modules.md

@@ -32,7 +32,7 @@
 | `generators.getting_started_gen` | 166 | 0 | 1 | 5.8 | Getting Started guide generator. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/getting_started_gen.py) |
 | `generators.mkdocs_gen` | 70 | 0 | 1 | 2.2 | MkDocs configuration generator — auto-generate mkdocs.yml fr | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/mkdocs_gen.py) |
 | `generators.module_docs_gen` | 198 | 0 | 1 | 8.0 | Module documentation generator — single consolidated modules | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/module_docs_gen.py) |
-| `generators.readme_gen` | 456 | 1 | 1 | 5.7 | README.md generator from AnalysisResult. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py) |
+| `generators.readme_gen` | 463 | 1 | 1 | 5.7 | README.md generator from AnalysisResult. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py) |
 | `llm_helper` | 161 | 1 | 1 | 2.3 | LLM helper — optional LLM-assisted documentation generation  | [source](https://github.com/wronai/code2docs/blob/main/code2docs/llm_helper.py) |
 | `registry` | 39 | 0 | 1 | 2.5 | Generator registry — pluggable generator system. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/registry.py) |
 | `sync.differ` | 125 | 0 | 2 | 3.6 | Detect changes in source code for selective documentation re | [source](https://github.com/wronai/code2docs/blob/main/code2docs/sync/differ.py) |
@@ -494,7 +494,7 @@ README.md generator from AnalysisResult.
 | `generate` | `` | `—` | 3 |
 | `write` | `path, content` | `—` | 4 |
 
-- `generate_readme(project_path, output, sections, sync_markers, config)` — Convenience function to generate a README. [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439)
+- `generate_readme(project_path, output, sections, sync_markers, config)` — Convenience function to generate a README. [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L446)
 
 ## sync
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "code2docs"
-version = "0.2.7"
+version = "0.2.8"
 description = "Auto-generate and sync project documentation from source code analysis"
 readme = "README.md"
 requires-python = ">=3.9"