docs: fix documentation audit findings#200
Merged
Merged
Conversation
added 3 commits
June 18, 2026 04:03
- .dockerignore: add !README.md and !LICENSE allowlist entries so they're available during the builder stage - Dockerfile: copy README.md in builder stage (required by hatchling for readme field in pyproject.toml) Fixes #198
- README.md: fix project structure tree — entrypoint.sh path to docker/entrypoint.sh, add missing labeler.yml workflow, add AUDNET_SMTP_PASSWORD to Docker env var table - SECURITY.md: update version table — 0.3.x supported, 0.2.x EOL - CHANGELOG.md: move all v0.3.0 bug fixes, performance, and enhancement items from [Unreleased] to [0.3.0] section; keep only truly unreleased items under [Unreleased] - Remove MARKDOWN_AUDIT.md (completed working document, now historical)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 6 documentation issues found during comprehensive audit of all markdown files against the current codebase state.
Changes
entrypoint.shpath from root todocker/entrypoint.sh; added missinglabeler.ymlworkflow to the treeAUDNET_SMTP_PASSWORD(used bylistencommand, was only in CLI help text)0.3.xas supported,0.2.xas EOL,0.1.xas EOL[Unreleased]to the[0.3.0]section. Only truly unreleased items (Docker publish fix, docs fixes) remain under[Unreleased]Testing