engineering / skill
Docs vs Code Checker
Check documentation claims against local source with file and line evidence.
At a glance
- Purpose
- Check documentation claims against local source with file and line evidence.
- Runs in
- Local agent with shell
- Operating systems
- macOS, Linux
- Needs
- Runtime: Python 3.10+, standard library only; Needs internet: No; Needs accounts or API keys beyond your agent: No
- Files and data
- Reads files: Yes; Writes files: Yes; Sends data to other services: No
- Tool type
- Skill
- Delivery
- Download from Skills Outpost
- Version
- 0.1.0
- ZIP SHA-256
- 256b36a3fa784c580d308c97d5c7ee0202eb8b0996a888a144d9e41c62217f1d
- Access
- Download from Skills Outpost
- Compatibility
- Python 3.10 or newer on macOS and Linux with POSIX directory descriptors and no-follow APIs; Windows and other platforms fail before filesystem I/O. Agent Skills compatible harness, standard library only, offline.
- External costs
- None. The package is free under the MIT license and makes no network requests.
- Permissions
- Read exact named local docs and report JSON; inspect all non-symlink regular repository files beneath pinned --root, bounded to 1 MiB plus one overflow byte per file. Absolute local selections are allowed; user-supplied paths refuse parent traversal, percent encoding and backslashes. Repository entry names accept literal percent signs and backslashes. Create one report in an existing directory after approval bound to resolved destination, directory/parent identities and bytes. No directory creation, credentials, stdin or network.
- Usage terms
- MIT license. Copyright 2026 Zero Width Lab. No third-party service or vendor product is used, so no trademark notice applies. By Zero Width Lab (zerowidthlab.com)
Download from Skills Outpost
Get this version
FreeStatic source, format, secret-pattern and declaration checks with independent human source review.
- SHA-256 of the released ZIP
256b36a3fa784c580d308c97d5c7ee0202eb8b0996a888a144d9e41c62217f1d
The creator shows this version's package files publicly: anyone can read SKILL.md and the other files under Files, without an account. The ZIP download needs the version in your Library (how it works).
Sign in to add this version to your library and follow its creator for free.
Sign in to get freeA creator follow is free, not a paid membership. Your email is not shared with the creator.
Files
Version 0.1.0, shown publicly by its creator, exactly as in this version's ZIP. ZIP SHA-256: 256b36a3fa784c580d308c97d5c7ee0202eb8b0996a888a144d9e41c62217f1d. License: MIT (read it).
Each file has its own address. Read one as a web page at https://, or as JSON at https://; replace SKILL.md with any path below.
- manifest.json · 2.1 KiB
- LICENSE.txt · 1.0 KiB
- README.md · 2.5 KiB
- SETUP.md · 3.6 KiB
- SKILL.md · 3.2 KiB
- agents/docs-vs-code-checker.md · 4.1 KiB
- references/method.md · 3.4 KiB
- scripts/docs_claims.py · 16.8 KiB
- source-package.json · 2.7 KiB
- tests/fixtures/mini-repo/README.md · 155 B
- tests/fixtures/mini-repo/app.py · 251 B
- tests/test_docs_claims.py · 15.2 KiB
- tests/test_hygiene.py · 2.5 KiB
MIT
MIT LicenseCopyright (c) 2026 Zero Width Lab
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Version history
- Version 0.1.0 Current
No release notes for this version.
What it does
Docs vs Code Checker is an offline skill with a companion agent that checks factual project documentation claims against local source. An agent harness is software that loads the agent instructions, reads local files, and runs the bundled command-line helper. It needs macOS/Linux with POSIX no-follow directory APIs, Python 3.10 or newer and access to the project files selected for review. It is free under the MIT license. This listing delivers the complete package with scripts.The helper searches all regular UTF-8 text files within 1 MiB, regardless of extension, while skipping named dependency and build directories. It counts NUL-detected binary files separately. Unreadable, undecodable, or oversized text files make coverage incomplete. The helper extracts likely claims about flags, commands, environment variables, paths, names, numbers, versions, exit codes, defaults, and platforms. It locates identifiers and inventories source-level flags, environment reads, and version constants. The agent checks each claim in context and assigns TRUE, FALSE, STALE, or UNVERIFIABLE with file:line evidence; it does not guess from a search hit. The final summary counts supplied verdict labels; it does not validate evidence truth or runtime behavior.
The package runs without network access, credentials, dependency installation, or project-code execution. The only optional write is a Markdown report. Approval-gated means its dry run prints a digest bound to the exact report content, resolved output path and destination directory/parent identities, and live creation requires that digest. Existing files and symlinks are refused. Partial scans identify skipped text files and exit 2 unless the user explicitly accepts partial coverage.
Who it is for
Maintainers, reviewers, and documentation writers who want a local agent to compare project docs with implementation evidence.Example tasks
Check every factual claim in my README against this repository.Find outdated documented CLI flags and defaults.
Inventory environment variables and version constants in source.
Produce a reviewed Markdown report with evidence for each claim.
Getting started
SKILL.md and the scripts can be read without an account: SKILL.md at https://