Skip to content

docs: fix documentation audit findings#200

Merged
Elshayib merged 3 commits into
masterfrom
fix/docs-audit-fixes
Jun 18, 2026
Merged

docs: fix documentation audit findings#200
Elshayib merged 3 commits into
masterfrom
fix/docs-audit-fixes

Conversation

@Elshayib

Copy link
Copy Markdown
Owner

Summary

Fixes 6 documentation issues found during comprehensive audit of all markdown files against the current codebase state.

Changes

  1. README.md — Project structure tree: Fixed entrypoint.sh path from root to docker/entrypoint.sh; added missing labeler.yml workflow to the tree
  2. README.md — Docker env var table: Added AUDNET_SMTP_PASSWORD (used by listen command, was only in CLI help text)
  3. SECURITY.md — Version table: Updated to show 0.3.x as supported, 0.2.x as EOL, 0.1.x as EOL
  4. CHANGELOG.md — Reorganized: Moved all v0.3.0 items (bug fixes, performance, dependencies, build) from [Unreleased] to the [0.3.0] section. Only truly unreleased items (Docker publish fix, docs fixes) remain under [Unreleased]
  5. Removed MARKDOWN_AUDIT.md: Completed working document, no longer needed in repo root

Testing

  • All 639 tests pass
  • No code changes — documentation only

islam666 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)
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jun 18, 2026
@Elshayib Elshayib merged commit cf8cffd into master Jun 18, 2026
6 checks passed
@Elshayib Elshayib deleted the fix/docs-audit-fixes branch June 18, 2026 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant