Skip to content

docs: fix format count, missing formats, TIFF description, and orphaned sentence#105

Merged
Hexagon merged 3 commits into
mainfrom
copilot/review-documentation-accuracy
Apr 10, 2026
Merged

docs: fix format count, missing formats, TIFF description, and orphaned sentence#105
Hexagon merged 3 commits into
mainfrom
copilot/review-documentation-accuracy

Conversation

Copilot AI commented Apr 10, 2026

Copy link
Copy Markdown
Contributor
  • Identify documentation issues
  • Fix docs/src/index.md: format count (15 → 18), missing PGM/PBM/QOI in pure-JS list, inaccurate TIFF description
  • Fix README.md: repair split/orphaned sentence in JPEG Tolerant Decoding section
  • Fix docs/src/examples/decoding-encoding.md: add missing QOI, PGM, PBM examples
  • Fix README.md: restore missing blank line after ## CMYK Color Space Support heading (fixes deno fmt CI failure)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation to reflect the recently added PGM/PBM/QOI formats and corrects a misplaced sentence in the README, improving accuracy and completeness of format-related docs.

Changes:

  • Correct supported format count and update the “full pure-JS” format list to include PGM/PBM/QOI.
  • Refine the TIFF capability description to match current implementation.
  • Add QOI/PGM/PBM format examples and fix an orphaned README sentence fragment by moving it back into the intended note.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
README.md Moves the runtime-decoder fallback sentence back into the JPEG tolerant decoding note (but currently drops the CMYK section header).
docs/src/index.md Updates supported format count/list and corrects the TIFF description.
docs/src/examples/decoding-encoding.md Adds QOI/PGM/PBM encoding examples alongside existing format examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Hexagon

Hexagon commented Apr 10, 2026

Copy link
Copy Markdown
Member

@copilot have a look at the ci failures

Copilot AI commented Apr 10, 2026

Copy link
Copy Markdown
Contributor Author

@copilot have a look at the ci failures

The CI failure was a deno fmt error — the ## CMYK Color Space Support heading was missing a blank line before the following paragraph. Fixed in 6c49422.

Copilot AI requested a review from Hexagon April 10, 2026 21:17
@Hexagon Hexagon merged commit 4a9a890 into main Apr 10, 2026
5 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.

3 participants