Skip to content

Correct stale documentation and enforce link integrity #77

Closed

Description

@stefan-jansen

Problem

Published documentation contains stale repository references, source paths, development commands, version-qualified provider status, and duplicate legacy pages that conflict with the current package and workflows. The release documentation verifier checks identity metadata but not all README and documentation links, deployed navigation, assets, and fragments required by the ecosystem documentation standard.

Acceptance criteria

  • Published setup, testing, architecture, provider-extension, and update guidance use canonical paths, uv, current APIs, and actual CI/test lanes.
  • Duplicate legacy pages with obsolete commands and release claims are removed or consolidated into maintained guides.
  • Version-qualified provider status matches the 0.2.0 release evidence.
  • Every README link and rendered documentation content link is checked by CI.
  • Rendered and deployed validation detects broken navigation, assets, internal links, and fragments.
  • Focused tests demonstrate that broken links fail and valid documentation passes.
  • Ruff, ty, tests, strict MkDocs, package build, actionlint, pre-commit, and ecosystem qualification pass.

Activity

  1. changed the title [-]Correct contributor documentation and enforce link integrity[/-] [+]Correct stale documentation and enforce link integrity[/+] on Oct 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions