Skip to content

Docs audit [April 2026]: Tooling update #3296

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

Merged
C-Achard merged 10 commits into from
May 21, 2026
Merged

Docs audit [April 2026]: Tooling update #3296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ac89a16
Add docs and notebooks audit export tool
C-Achard Apr 15, 2026
e192c9d
Ignore tools/docs_audits in docs scan
C-Achard Apr 15, 2026
09ec1e8
Ignore docs_audits; include tools MD files
C-Achard Apr 15, 2026
57369ac
Introduce markdown-myst pre-commit hook
C-Achard Apr 21, 2026
759956e
Add notes field and 'move' recommendation
C-Achard Apr 27, 2026
ced7cc6
Document Recommendation enum values
C-Achard Apr 28, 2026
e025225
Update docs_and_notebooks_audit.py
C-Achard Apr 28, 2026
7a7b5ea
Merge branch 'main' into cy/docs-audit-april-2026-tooling
C-Achard May 11, 2026
9f61c2f
Fix pre-commit YAML indent and update usage examples
C-Achard May 11, 2026
412002c
Merge branch 'main' into cy/docs-audit-april-2026-tooling
C-Achard May 12, 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
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ repos:
args: [--check, --diff]
stages: [manual]

- repo: https://github.com/hukkin/mdformat
rev: 1.0.0
hooks:
- id: mdformat
additional_dependencies:
- mdformat-myst
files: ^docs/.*\.md$
stages: [pre-commit]

# check only, no modifications
- repo: local
hooks:
Expand All @@ -91,6 +100,7 @@ repos:
language: python
pass_filenames: true
files: ^(docs/|examples/(JUPYTER|COLAB)/|tools/).*(\.md|\.ipynb)$
exclude: ^tools/docs_audits/
args:
- --config
- tools/docs_and_notebooks_report_config.yml
Expand Down
Loading
Loading