Skip to content

docs: add SUPPORT.md and clarify known conversion limits - #88

Open
HaoChiBao wants to merge 2 commits into
firecrawl:mainfrom
HaoChiBao:docs/support-and-clarifications
Open

docs: add SUPPORT.md and clarify known conversion limits#88
HaoChiBao wants to merge 2 commits into
firecrawl:mainfrom
HaoChiBao:docs/support-and-clarifications

Conversation

@HaoChiBao

@HaoChiBao HaoChiBao commented Aug 13, 2026

Copy link
Copy Markdown

Summary

  • Add SUPPORT.md documenting what each input format keeps, reduces, or drops (images as alt text, headers/footers, spreadsheet visibility and number formats, nested tables, PDF model/OCR limits, and more), grounded in current parser behavior.
  • Link that page from the README Supported formats section and from the convert-documents agent skill.
  • Document that literal line-start 1. in plain paragraphs is escaped as 1\. on purpose so Markdown does not invent a list. Real Word w:numPr lists still render as normal ordered lists. Closes the confusion in docx to md puts a backslash between number and period in ordered lists #41 after inspecting the attached sample (no numbering part / no w:numPr).
  • Note the pdf-inspector = 0.1.8 floor in Cargo.toml so the RUSTSEC-2026-0187 lopdf fix (0.42.0) is not lowered by accident. main already resolves the fixed versions; transitive DoS via pdf-inspector -> lopdf 0.41.0 (RUSTSEC-2026-0187) #67 can close with this clarification.

Closes #2
Closes #41
Closes #67

Test plan

  • Skim SUPPORT.md against README Features / Supported formats for tone and accuracy
  • Spot-check a few claims against src/formats/** (headers/footers, PDF to_document, spreadsheet number formats)
  • Confirm README and skill links to SUPPORT.md resolve
  • Confirm Cargo.toml still requires pdf-inspector = 0.1.8 and cargo tree -i lopdf --locked shows only 0.42.0
  • Optional: convert the docx to md puts a backslash between number and period in ordered lists #41 sample and confirm 1\. output remains expected for literal paragraph text

Summary by cubic

Adds SUPPORT.md documenting per-format conversion limits and links it from the README and convert-documents skill. Also clarifies the intentional escaping of literal line-start list markers and records the pdf-inspector 0.1.8 floor to keep the lopdf RUSTSEC fix. No behavior change.

Verification

  • Confirm SUPPORT.md matches current parsers (images as alt text, headers/footers omitted, nested table flattening, spreadsheet number formats/visibility, PDF to_document unsupported, no OCR).
  • Check README and skill links resolve.
  • Confirm Cargo.toml retains pdf-inspector = "0.1.8" so lopdf >= 0.42.0 stays resolved.

Written for commit 5ebae8e. Summary will update on new commits.

Review in cubic

Document per-format keep/drop behavior, note intentional escaping of
literal line-start list markers, and record the pdf-inspector 0.1.8
floor that pulls in the RUSTSEC-2026-0187 lopdf fix.

Closes firecrawl#2
Closes firecrawl#41
Closes firecrawl#67

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 4 files

Re-trigger cubic

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

Labels

None yet

Projects

None yet

1 participant