Skip to content

docs: update documentation to match current codebase#25

Merged
JonRC merged 1 commit intomainfrom
docs/update-documentation
Feb 10, 2026
Merged

docs: update documentation to match current codebase#25
JonRC merged 1 commit intomainfrom
docs/update-documentation

Conversation

@JonRC
Copy link
Copy Markdown
Owner

@JonRC JonRC commented Feb 10, 2026

Summary

  • Verified all 12 docs files in /docs against source code
  • Fixed outdated content in 9 files (3 were already accurate)
  • Key fixes: missing PDF format references, outdated function signatures, missing test suites in CI docs, 12 missing visual test cases

Changes by file

File Changes
CONVERSION.md Fix rendering pipeline step 7
DIFF.md Add --format option, add piping section
PDF-EXPORT.md Fix exportToPng signature, format routing, stdout, RenderOptions inheritance
INFO.md Fix buildInfoArgs line reference
WATCH.md Document cross-platform browser open
UNIT-TESTS.md Add 6 missing test dirs, all commands, full CI table
VISUAL-REGRESSION-TESTING.md Fix SVG threshold, add 12 missing test cases
DOCKER_HUB.md Add PDF format, options, example
DOCKER_HUB_DESCRIPTION.md Add PDF to format list

Test plan

  • Verify CI passes (docs-only change, no code changes)

Verified all 12 docs files against source code and fixed outdated content:

- CONVERSION.md: fix rendering pipeline step 7 (PNG → PNG/SVG/PDF)
- DIFF.md: add missing --format option, add piping section
- PDF-EXPORT.md: fix exportToPng signature, format routing, stdout support, RenderOptions inheritance
- INFO.md: fix buildInfoArgs line reference
- WATCH.md: fix browser open to document cross-platform support
- UNIT-TESTS.md: add 6 missing test directories, all test commands, full CI job table
- VISUAL-REGRESSION-TESTING.md: fix SVG threshold (1%→5%), add image-elements dark variant, add 12 missing test cases
- DOCKER_HUB.md: add PDF format, --transparent/--frame options, PDF example
- DOCKER_HUB_DESCRIPTION.md: add PDF to format list
- BUILD.md, COMBINE.md, LINUX-INSTALLATION.md: verified accurate, no changes needed
@JonRC JonRC merged commit b496de6 into main Feb 10, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant