Skip to content

docs: add release note#342

Merged
Moskize91 merged 2 commits intomainfrom
docs
Feb 3, 2026
Merged

docs: add release note#342
Moskize91 merged 2 commits intomainfrom
docs

Conversation

@Moskize91
Copy link
Copy Markdown
Contributor

No description provided.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 3, 2026

Summary by CodeRabbit

  • New Features

    • Added optional LLM-powered analysis to enhance table of contents extraction and chapter title detection.
    • Improved error handling with graceful degradation during content conversion.
  • Documentation

    • Updated migration guide for simplified table of contents parameter configuration.
    • Clarified default settings across different document formats.

Walkthrough

This PR replaces the TocExtractionMode enum with a simpler boolean toc_assumed parameter in transform_markdown (default False) and transform_epub (default True). The change removes TocExtractionMode from the public API. Documentation updates in README files (English and Chinese) clarify the new API with examples. A new changelog (v1.0.10) documents the breaking changes and migration path from the old enum-based API. The version is bumped to 1.0.10 in pyproject.toml. Additionally, LLM-powered TOC analysis is introduced via the new toc_llm parameter.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format '(): ' with 'docs' as the type and 'add release note' as the subject, accurately reflecting the main change of adding changelog documentation.
Description check ✅ Passed Although no explicit description was provided, the pull request changes are self-evident from the file modifications, and the title adequately conveys the purpose of adding release notes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/changelog/v1.0.10.md`:
- Around line 14-17: Update the sentence "Provides more accurate chapter level
detection for complex book structures" to use a hyphenated compound adjective:
change it to "Provides more accurate chapter-level detection for complex book
structures" (locate the exact string in the changelog entry under the
LLM-Powered Chapter Title Analysis bullet).

Comment on lines +14 to +17
* **LLM-Powered Chapter Title Analysis**: Added support for LLM-based analysis of chapter titles to enhance TOC extraction accuracy in https://github.com/oomol-lab/pdf-craft/pull/341
- Automatically analyzes chapter title hierarchies when `toc_llm` is configured
- Provides more accurate chapter level detection for complex book structures
- Intelligently falls back to standard analysis when LLM is unavailable or encounters errors
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Minor grammar fix: use hyphenated compound adjective.

On line 16, "chapter level detection" should be "chapter-level detection" when used as a compound adjective modifying "detection".

📝 Suggested fix
-  - Provides more accurate chapter level detection for complex book structures
+  - Provides more accurate chapter-level detection for complex book structures
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* **LLM-Powered Chapter Title Analysis**: Added support for LLM-based analysis of chapter titles to enhance TOC extraction accuracy in https://github.com/oomol-lab/pdf-craft/pull/341
- Automatically analyzes chapter title hierarchies when `toc_llm` is configured
- Provides more accurate chapter level detection for complex book structures
- Intelligently falls back to standard analysis when LLM is unavailable or encounters errors
* **LLM-Powered Chapter Title Analysis**: Added support for LLM-based analysis of chapter titles to enhance TOC extraction accuracy in https://github.com/oomol-lab/pdf-craft/pull/341
- Automatically analyzes chapter title hierarchies when `toc_llm` is configured
- Provides more accurate chapter-level detection for complex book structures
- Intelligently falls back to standard analysis when LLM is unavailable or encounters errors
🧰 Tools
🪛 LanguageTool

[grammar] ~16-~16: Use a hyphen to join words.
Context: ...gured - Provides more accurate chapter level detection for complex book structu...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@docs/changelog/v1.0.10.md` around lines 14 - 17, Update the sentence
"Provides more accurate chapter level detection for complex book structures" to
use a hyphenated compound adjective: change it to "Provides more accurate
chapter-level detection for complex book structures" (locate the exact string in
the changelog entry under the LLM-Powered Chapter Title Analysis bullet).

@Moskize91 Moskize91 merged commit 9b4876e into main Feb 3, 2026
1 of 2 checks passed
@Moskize91 Moskize91 deleted the docs branch February 3, 2026 05:27
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