Skip to content

Documentation Improvement: Add Descriptions and Context for Features #1505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yash8745 opened this issue May 1, 2025 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@Yash8745
Copy link

Yash8745 commented May 1, 2025

While using Docling, I noticed that the documentation mostly consists of code snippets without any explanation of what the modules do or how they work. Features like OCR, image extraction, and multimodal pipelines are mentioned, but there’s no description of their purpose, usage, or expected outputs.

Adding short explanations (e.g., what OCR does, when to use certain pipelines, supported formats) would make the documentation far more helpful, especially for new users.

Alternatives
Right now, the only way to understand the system is by reading the source code, which is time-consuming. Improving the docs would make the tool more accessible and easier to adopt.

@Yash8745 Yash8745 added the enhancement New feature or request label May 1, 2025
@dolfim-ibm
Copy link
Contributor

It will be improved, meanwhile you could also look at the technical report https://arxiv.org/pdf/2501.17887

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants