Skip to content

docs(cli): list supported formats in info and convert help - #2292

Open
MMexicann wants to merge 1 commit into
storytold:mainfrom
MMexicann:patch-24
Open

MMexicann wants to merge 1 commit into
storytold:mainfrom
MMexicann:patch-24

Conversation

@MMexicann

@MMexicann MMexicann commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

CLI users can see which presentation and outline formats info and convert accept, and which formats convert can write.

The help named only .deckcraft and .pptx as inputs. Both commands use the same opener, which also accepts PowerPoint variants, legacy PowerPoint files, and text outlines. The convert output list now matches the engine’s writable extensions.

Verified both help entries against the shared opener and WRITABLE_EXTENSIONS on main, and reviewed the one-file diff. The Rust build and CLI tests were not run locally.

Summary by CodeRabbit

  • Documentation
    • Updated CLI help to list the supported input and output formats for info and convert, including PowerPoint template and slideshow formats, RTF, text, and Markdown.
    • Clarified that conversion can produce a JPEG image of the first slide.
    • Expanded info help to describe the slide and presentation metadata it reports.

Updated details for 'info' and 'convert' subcommands to include additional file formats and clarify output.
@coderabbitai

coderabbitai Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The info and convert help text now lists additional input and output formats. The info text also describes the slide and presentation metadata printed as JSON.

Changes: CLI help text

Layer / File(s) Summary
Document supported formats
apps/deckcraft-cli/src/help.rs
The info help text lists additional input formats and describes the reported metadata. The convert help text lists additional input formats, output formats, and first-slide image formats.

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

Change: Other

Suggested reviewers: hoblin, echelon

Merge Risk: Minimal · up to 701be

This change updates the CLI help text to list more supported input and output formats. The listed formats match what the importer and exporter handle, so there is no meaningful risk in merging it.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs(cli): list supported formats in info and convert help" matches the changeset. The diff updates only the help text in apps/deckcraft-cli/src/help.rs. It lists the new input formats for …
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.
Full details: Title check

Explanation

The title "docs(cli): list supported formats in info and convert help" matches the changeset. The diff updates only the help text in apps/deckcraft-cli/src/help.rs. It lists the new input formats for info (.deckcraft, PowerPoint, RTF, text, Markdown) and for convert (.potx, .ppsx, .pot, .pps). It also updates the convert output list (.potx, .ppsx, .rtf, .jpeg). The title names the main change and the affected commands. It uses a conventional commit prefix and is specific.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between c355c06 and 701be77.

Files selected for processing: 1

  • apps/deckcraft-cli/src/help.rs

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@autocraft-bot autocraft-bot Bot added the infra Tests, CI, docs, build, packaging, tooling label Nov 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infra Tests, CI, docs, build, packaging, tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant