Skip to content

Restore architecture diagrams so strict docs builds pass #89

@Faerkeren

Description

@Faerkeren

Problem

docs/architecture.md:3-4 says architecture diagrams are regenerated from source on every docs build, but mkdocs.yml:53-66 does not run tools/generate_diagrams.py.

The page links to missing files at docs/architecture.md:8 and docs/architecture.md:12:

![Class Diagram](architecture/classes.svg)
![Package Diagram](architecture/packages.svg)

tools/generate_diagrams.py:26-31 writes those files under docs/architecture/, but that directory is absent in the repository.

Verified failure:

uv run --extra docs mkdocs build --strict
WARNING - Doc file 'architecture.md' contains a link 'architecture/classes.svg', but the target is not found among documentation files.
WARNING - Doc file 'architecture.md' contains a link 'architecture/packages.svg', but the target is not found among documentation files.
Aborted with 2 warnings in strict mode!

Suggested Fix

Either commit generated docs/architecture/classes.svg and docs/architecture/packages.svg, or wire diagram generation into the docs build before MkDocs validates links.

Also update docs/architecture.md so it describes the real workflow. If diagrams are generated manually or in CI, say that directly instead of claiming every docs build regenerates them.

Rationale

The docs site has broken images, and strict docs builds fail. This blocks reliable documentation CI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentation and docstringsbugSomething isn't workingseverity:medMedium severity

    Type

    No fields configured for Bug.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions