Skip to content

feat: surface module check results directly on the website #91

@KristjanESPERANTO

Description

@KristjanESPERANTO

Summary

Expose the automated module check findings (currently available via docs/result.html and docs/data/modules.json) directly within the website UI, e.g. as a tooltip or modal popup from each module card, while still allowing access to the full aggregated list of issues.

Motivation

  • Make it easier for visitors and maintainers to spot problems (missing screenshots, outdated dependencies, etc.) without leaving the module list.
  • Encourage quicker follow-up on recommendations by keeping the context in one place.
  • Preserve discoverability features, such as scanning the complete list of findings, for research and prioritisation workflows.

Requirements & Ideas

  • Add a lightweight UI element (badge, icon, popup, tooltip) on module entries indicating that issues are available.
  • Display a concise version of the findings in-place (grouped by severity/category if possible).
  • Provide an obvious way to open the full result.html (or equivalent view) so that bulk searches and filtering remain possible.
  • Avoid heavy additional data fetches; reuse the existing modules.json payload and ensure client-side performance stays acceptable.
  • Consider accessibility (keyboard navigation, screen readers) and localisation.

Open Questions

  • Should badges or severity indicators be visible directly in the list view?
  • Do we need pagination or caching for the popup data?
  • Can we link directly to related documentation or forum topics for common issues?
  • How do we version/cache the results to prevent stale or inconsistent data in the UI?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions