docs: add agent skill bundle for coding assistants (SKILL.md, pipelines, convert/evaluate)#3174
Open
jehlum11 wants to merge 5 commits intodocling-project:mainfrom
Open
Conversation
- Add docs/examples/agent_skill/docling-document-intelligence/ with SKILL.md, pipelines.md, EXAMPLE.md, improvement-log template, and scripts/docling-convert.py + docling-evaluate.py (standard/vlm-local/vlm-api). - Document InputFormat.PDF + PdfFormatOption for explicit PdfPipelineOptions. - Link from examples index and mkdocs nav. Made-with: Cursor
- Document both ~/.cursor/skills and docs/examples paths. - README notes repo parity for PRs and local installs. Made-with: Cursor
Contributor
|
✅ DCO Check Passed Thanks @jehlum11, all your commits are properly signed off. 🎉 |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
Member
|
@jehlum11 do you think we could instrument the SKILL for using the |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
PeterStaar-IBM
previously approved these changes
Mar 26, 2026
Address maintainer feedback: the custom docling-convert.py script was largely redundant with the existing docling CLI. This commit: - Removes scripts/docling-convert.py (redundant with `docling` CLI) - Refactors SKILL.md (v1.4 → v2.0) to use `docling` CLI for all conversion tasks, reserving the Python API only for features the CLI does not expose (chunking, VLM API endpoint config, force_backend_text hybrid mode) - Updates docling-evaluate.py recommended_actions to reference `docling` CLI flags instead of the removed script - Updates README.md, EXAMPLE.md, pipelines.md to use `docling` CLI examples throughout - Simplifies requirements.txt (removes packaging dependency) The only custom script retained is docling-evaluate.py, which provides heuristic quality evaluation — functionality the CLI does not cover. Signed-off-by: jehlum11 <jehlum11@gmail.com> Made-with: Cursor
Signed-off-by: jehlum11 <jehlum11@gmail.com> Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an Agent Skill-style bundle under
docs/examples/agent_skill/docling-document-intelligence/so tools like Cursor, Claude Code, and other assistants can follow a consistent convert → export JSON → evaluate → refine workflow when users ask to parse documents with Docling.This is documentation + example scripts only; it does not change the
doclinglibrary API or default behavior.Contents
README.mdSKILL.mdpipelines.mdEXAMPLE.md~/.cursor/skills/and running helpers from the bundle rootimprovement-log.mdscripts/docling-convert.pystandard/vlm-local/vlm-api)scripts/docling-evaluate.pyexport_to_dictJSON (+ optional Markdown path)scripts/requirements.txtdocling,docling-core,packaging(aligned with 2.81+)Docs site
docs/examples/index.mdmkdocs.yml: Examples → Agent skill (Cursor / assistants)Technical notes
PdfPipelineOptionswiring usesInputFormat.PDF+PdfFormatOption(required for docling 2.81+; string keys like"pdf"are invalid and error at runtime).OcrMacOptionsfrom the public API.generate_page_images=Trueandenable_remote_services=Truewhere applicable.SPDX-License-Identifier: MIT) to match the repository.How to verify locally
pip install -r docs/examples/agent_skill/docling-document-intelligence/scripts/requirements.txt python3 docs/examples/agent_skill/docling-document-intelligence/scripts/docling-convert.py \ https://arxiv.org/pdf/2408.09869 --out /tmp/docling-smoke.md uv run mkdocs build # from repo root with project env