Skip to content

📝 docs: bring CLAUDE.md and the package comment up to date after PPTX - #90

Merged
135yshr merged 2 commits into
mainfrom
chore/post-pptx-cleanup
Sep 21, 2026
Merged

135yshr merged 2 commits into
mainfrom
chore/post-pptx-cleanup

Conversation

@135yshr

@135yshr 135yshr commented Sep 21, 2026 •

Copy link
Copy Markdown
Owner

Summary

Documentation cleanup after the PPTX epic (#72). No behavior change.

Refs #72

Changes

  • CLAUDE.md
    • Removed the sentence about slideModeCSS, which feat: add a slide stylesheet and the class directive #76 replaced with slideBaseCSS; the page-break, overflow: hidden and body-padding rules are now described where they actually live (slideBaseCSS), and slideSizeCSS is described as what it now does (fixed slide size plus @page size).
    • Config.Format lists pptx; the Config summary names the slide options (Slides, PaperFlagsSet); "all three pipelines" → "every pipeline".
    • resolveOutputPath: -o is required from stdin for every file format (pdf, html, pptx, docx), not just pdf/docx — matching inputs.go.
    • resolveFormat infers pptx from .pptx; -doctor blocks pptx as well as pdf on a missing Chromium.
  • internal/converter/converter.go package comment: said PDF was printed "via the Playwright Python driver", which has not been true since chromedp replaced it; now also mentions HTML and PPTX output. The remaining "Playwright" mentions in the code are about where Chromium is searched for (Playwright's browser cache) and are still accurate.

Local-only cleanup also done: the eight merged feat/73–feat/80 branches were deleted locally (their remote branches were already gone).

Not changed

origin/feat/44-mermaid-ascii-art is left in place: its PR #47 was closed without merging and it holds three commits that are not on main, so deleting it would lose work. Remove it by hand if it is no longer needed.

Tests

go vet ./..., go test ./..., golangci-lint run ./... (0 issues).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated architecture documentation to list PPTX as a supported output format.
    • Clarified output behavior for HTML, PDF, PPTX, DOCX, and console formats.
    • Documented that PDF and PPTX rendering use headless Chromium.
    • Added .pptx to the documented output extension options.
    • Revised slide-mode documentation to reflect current sizing, overflow, and body-padding behavior.

CLAUDE.md still described slideModeCSS, removed when decks got their own
stylesheet, listed formats without pptx, and said stdin needs -o only for
pdf and docx. The converter package comment still said PDF printing went
through the Playwright Python driver.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-21T13:40:59.816742Z b220ad6 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

Warning

Review limit reached

Next included review available in 56 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 07a61138-3faa-4c8a-89e4-01f3d1c76329

📥 Commits

Reviewing files that changed from the base of the PR and between b220ad6 and 9449d8c.

📒 Files selected for processing (1)
  • internal/converter/converter.go

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: ab56fc7f-27e7-4010-b5c5-df77620c0b68

📥 Commits

Reviewing files that changed from the base of the PR and between 92f6ca5 and b220ad6.

📒 Files selected for processing (2)
  • CLAUDE.md
  • internal/converter/converter.go

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation now describes PPTX support, the Chromium DevTools Protocol pipeline, HTML and PPTX behavior, and the current slide CSS assembly.

Changes

Documentation alignment

Layer / File(s) Summary
Pipeline and slide documentation
CLAUDE.md, internal/converter/converter.go
The documentation lists HTML and PPTX output, adds .pptx format resolution, describes Chromium printing and slide capture, and documents the current slide CSS assembly and sizing rules.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation changes in CLAUDE.md and the package comment, and it correctly relates them to the PPTX updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit reads the slides with care
Chromium sends the pages through air
HTML and PPTX join the stream
CSS shapes each slide like a dream
The docs now match the code’s bright beam

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b220ad6bb3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread internal/converter/converter.go Outdated
//
// DOCX output is produced directly from Markdown by pandoc, and console output
// is rendered to ANSI text by glamour; both bypass the HTML stage.
// HTML output stops after the third stage's HTML file. PPTX output renders the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Avoid implying HTML output is self-contained

When Markdown contains ordinary local images, FormatHTML returns before copyImages and deliberately leaves those image references external, as CLAUDE.md itself notes. By identifying HTML output with the “self-contained” stage described above, this comment can lead callers to move or distribute the HTML alone and get broken images; qualify that only CSS, fonts, and rendered Mermaid SVGs are embedded, while user images remain external.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Fixed: the comment now says HTML output is self-contained except for local images, which keep the relative paths the Markdown gave them rather than being copied.

Codex review on #90.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@135yshr 135yshr self-assigned this Sep 21, 2026
@135yshr
135yshr merged commit 3681de2 into main Sep 21, 2026
6 checks passed
@135yshr
135yshr deleted the chore/post-pptx-cleanup branch September 21, 2026 13:48
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