Skip to content

docs: correct stale guidance and enforce link integrity #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stefan-jansen wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: correct stale guidance and enforce link integrity #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
736b70f
docs: enforce published link integrity
Oct 10, 2026
b07427e
docs: replace stale contributor guidance
Oct 10, 2026
cd05d83
fix: retry deployed documentation probes
Oct 10, 2026
5262d06
docs: remove stale legacy guidance
Oct 10, 2026
af368c0
fix: tolerate transient external link failures
Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ jobs:
echo "ML4T_DOCS_VERSION=$(uv run python -c 'from ml4t.data import __version__; print(__version__)')" >> "$GITHUB_ENV"
echo "ML4T_DOCS_COMMIT=${GITHUB_SHA}" >> "$GITHUB_ENV"
- name: Build documentation strictly
run: uv run mkdocs build --strict
run: |
uv run python scripts/verify_readme_links.py
uv run mkdocs build --strict
- name: Verify rendered identity
run: >-
uv run python scripts/verify_documentation_identity.py
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ jobs:
ML4T_DOCS_COMMIT: ${{ needs.preflight.outputs.commit }}
ML4T_DOCS_VERSION: ${{ needs.preflight.outputs.version }}
run: |
uv run python scripts/verify_readme_links.py
uv run mkdocs build --strict
uv run python scripts/verify_documentation_identity.py \
--site site \
Expand Down
285 changes: 0 additions & 285 deletions docs/ASYNC_STORAGE.md
View file
Open in desktop

This file was deleted.

Loading
Loading