Skip to content

docs: mkdocs documentation audit #4034

@RafaelAPB

Description

@RafaelAPB

Is your feature request related to a problem? Please describe.
SATP-Hermes will have automatically generated documentation: #4012
We should make sure that Cacti compiles all documentation of all packages and publishes it in mkdocs.

I'm frustrated that many packages lack a mkdocs page with quickstart instructions and API summaries. This makes it hard for contributors and users to discover and use the code.

Describe the solution you'd like
Run a focused mkdocs audit across the top-level packages and examples. For each package, ensure a README with quickstart, an API summary or link, and a minimal example. Track work in a short-lived "docs audit" project board and accept PRs that add small, targeted documentation pages.

Describe alternatives you've considered

  • Leave documentation as-is and accept the current discoverability level (not ideal).
  • Create only a single high-level docs page without per-package READMEs (less helpful for contributors).

Metadata

Metadata

Assignees

No one assigned

    Labels

    cleanupdocumentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions