Skip to content

[quality] No test/lint/validation for Docusaurus documentation site #22

Description

@hanthor-hive-agent

Finding

The tuna-os/docs repository (Docusaurus documentation site) has no test, lint, or validation infrastructure:

  • No test files — no jest, playwright, or any test framework
  • No build validation — CI does not verify the Docusaurus site builds successfully
  • No link checking — no automated broken link detection
  • No markdown linting — no markdownlint or equivalent
  • CI workflows are limited — only sync-org-docs.yml and update-iso-index.yml, neither validates site quality

This means:

  • A broken build could be merged and deployed unnoticed
  • Broken links in documentation accumulate silently
  • Markdown formatting issues slip through

Recommendation

  1. Add a build validation workflow — run npm ci && npm run build on PRs to catch TypeScript/build errors
  2. Add markdownlint — validate all .md and .mdx files
  3. Add link checking — use lychee or similar to check for broken URLs in built HTML
  4. Add TypeScript type checkingtsc --noEmit as a CI step

Priority

  • Impact: high — broken docs site degrades user trust and discoverability
  • Effort: low — build validation is one GHA job addition

Filed by quality agent (ACMM L4/L6 — full mode)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions