[PR #119] Add docproof to Quality Assurance and GitHub Actions #2147

Open
opened 2026-08-20 03:25:54 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/testthedocs/awesome-docs/pull/119
Author: @melbinjp
Created: 8/19/2026
Status: 🔄 Open

Base: main ← Head: add-docproof


📝 Commits (1)

  • 0130abb Add docproof to Quality Assurance and GitHub Actions

📊 Changes

1 file changed (+2 additions, -0 deletions)

View changed files

📝 README.md (+2 -0)

📄 Description

Adds docproof to Quality Assurance and to GitHub Actions.

Disclosure: I wrote it.

It checks whether what documentation claims is still true of the repository: file paths, CLI
flags, versions, and documented imports, each resolved against the code and its git history.
No model and no network, so the same commit gives the same verdict.

Against the quality standards:

Generally useful Nobody outside my account uses it yet. Two fixes it found were merged upstream by their maintainers: sanity-io/sanity#14169, rolldown/rolldown#10719
Actively maintained 58 commits since 2026-08-10, most of them this week
Progressing toward stable v0.2.0, 208 tests green on Linux, macOS and Windows across Python 3.10 to 3.13
Documented README, config reference, published Action. MIT

Quality Assurance currently covers spelling, style, links and documentation testing. A link
checker is happy with a working link to a file that has moved, which is the failure this one
is for.

Two sections because the list already carries EkLine and Vale in both. Happy to drop either.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/testthedocs/awesome-docs/pull/119 **Author:** [@melbinjp](https://github.com/melbinjp) **Created:** 8/19/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `add-docproof` --- ### 📝 Commits (1) - [`0130abb`](https://github.com/testthedocs/awesome-docs/commit/0130abbcf75822034b59a2ea06606d6db9c66cba) Add docproof to Quality Assurance and GitHub Actions ### 📊 Changes **1 file changed** (+2 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+2 -0) </details> ### 📄 Description Adds docproof to Quality Assurance and to GitHub Actions. **Disclosure: I wrote it.** It checks whether what documentation claims is still true of the repository: file paths, CLI flags, versions, and documented imports, each resolved against the code and its git history. No model and no network, so the same commit gives the same verdict. Against the quality standards: | | | |---|---| | Generally useful | **Nobody outside my account uses it yet.** Two fixes it found were merged upstream by their maintainers: [sanity-io/sanity#14169](https://github.com/sanity-io/sanity/pull/14169), [rolldown/rolldown#10719](https://github.com/rolldown/rolldown/pull/10719) | | Actively maintained | 58 commits since 2026-08-10, most of them this week | | Progressing toward stable | v0.2.0, 208 tests green on Linux, macOS and Windows across Python 3.10 to 3.13 | | Documented | README, config reference, published Action. MIT | Quality Assurance currently covers spelling, style, links and documentation testing. A link checker is happy with a working link to a file that has moved, which is the failure this one is for. Two sections because the list already carries EkLine and Vale in both. Happy to drop either. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-08-20 03:25:54 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-docs#2147