Skip to content

docs: correct stale guidance and enforce link integrity - #78

Open
stefan-jansen wants to merge 5 commits into
mainfrom
codex/docs-link-integrity
Open

stefan-jansen wants to merge 5 commits into
mainfrom
codex/docs-link-integrity

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

Closes #77

Outcome

  • replaces stale contributor setup, testing, architecture, and provider-extension guidance with the current repository contracts
  • checks every README link during documentation and release qualification
  • validates rendered and deployed navigation, assets, internal links, and fragments
  • corrects the generated favicon reference

Compatibility

No public Python API or package compatibility impact.

Verification

  • uv run ruff check src tests scripts
  • uv run ruff format --check src tests scripts
  • uv run ty check
  • uv run pytest tests -q -ra --cov=ml4t.data --cov-report=term --cov-fail-under=0 (3,762 passed, 292 deselected, 86% coverage)
  • uv run pytest tests -q -ra -W error::ResourceWarning (3,762 passed, 292 deselected)
  • uv run python scripts/verify_readme_links.py
  • strict MkDocs build plus complete rendered-site link validation
  • wheel and sdist build, metadata validation, isolated install, import, CLI help, and README quick start
  • actionlint .github/workflows/*.yml
  • pre-commit run --all-files

The currently deployed 0.2.0 site correctly fails the new link verifier on its missing assets/favicon.ico; the candidate changes the configured favicon to the existing generated asset.

Copilot AI balanced review requested due to automatic review settings October 10, 2026 08:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@stefan-jansen stefan-jansen changed the title docs: correct contributor guidance and enforce link integrity docs: correct stale guidance and enforce link integrity Oct 10, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Correct stale documentation and enforce link integrity

2 participants