docling-project/docling
1
0
Fork 0
mirror of https://github.com/docling-project/docling.git synced 2026-05-17 13:10:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: align agent skill README and EXAMPLE with Cursor bundle

Browse Source 
- Document both ~/.cursor/skills and docs/examples paths.
- README notes repo parity for PRs and local installs.

Made-with: Cursor
This commit is contained in:
jehlum11
2026-03-23 15:28:00 -04:00
parent 2d268ffb6f
commit 041e709c66
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/examples/agent_skill/docling-document-intelligence/EXAMPLE.md
Vendored
+10 -4
View File
@@ -1,15 +1,21 @@
# Using the Docling agent skill
[Agent Skills](https://agentskills.io/specification) are folders of instructions that AI coding agents (Cursor, Claude Code, GitHub Copilot, etc.) can load when relevant. This bundle lives in the Docling repo at:
[Agent Skills](https://agentskills.io/specification) are folders of instructions that AI coding agents (Cursor, Claude Code, GitHub Copilot, etc.) can load when relevant.
`docs/examples/agent_skill/docling-document-intelligence/`
## Where this bundle lives
- **Cursor (local):** `~/.cursor/skills/docling-document-intelligence/` (or copy this folder there).
- **Docling repository (docs + PRs):** `docs/examples/agent_skill/docling-document-intelligence/` in [github.com/docling-project/docling](https://github.com/docling-project/docling).
The two trees are kept in sync; use either source.
## Install (copy into your agent’s skills directory)
```bash
# From a checkout of github.com/docling-project/docling
# From a checkout of the Docling repo
cp -r docs/examples/agent_skill/docling-document-intelligence ~/.cursor/skills/
# or e.g. ~/.claude/skills/ depending on your tool
# Or copy from another machine / archive into e.g. ~/.claude/skills/
```
No extra config is required beyond installing Python dependencies (below).
docs/examples/agent_skill/docling-document-intelligence/README.md
Vendored
+5 -7
View File
@@ -1,16 +1,18 @@
# Docling agent skill (Cursor & compatible assistants)
This folder is an **[Agent Skill](https://agentskills.io/specification)**-style bundle for AI coding assistants: structured instructions (`SKILL.md`), a pipeline reference (`pipelines.md`), optional helper scripts under `scripts/`, and an evaluator for conversion quality.
This folder is an **[Agent Skill](https://agentskills.io/specification)**-style bundle for AI coding assistants: structured instructions (`SKILL.md`), a pipeline reference (`pipelines.md`), helper scripts under `scripts/`, and an evaluator for conversion quality.
It complements the official [Docling documentation](https://docling-project.github.io/docling/) and the [`docling` CLI](https://docling-project.github.io/docling/reference/cli/); use it when you want agents to follow a consistent **convert → export JSON → evaluate → refine** workflow.
The same layout is published in the Docling repo at `docs/examples/agent_skill/docling-document-intelligence/` (for docs and PRs).
## Contents
| Path | Purpose |
|------|---------|
| [`SKILL.md`](SKILL.md) | Full skill instructions (pipelines, chunking, evaluation loop) |
| [`pipelines.md`](pipelines.md) | Standard vs VLM pipelines, OCR engines, API notes |
| [`EXAMPLE.md`](EXAMPLE.md) | Copying the skill into `~/.cursor/skills/` or similar; running scripts |
| [`EXAMPLE.md`](EXAMPLE.md) | Installing into `~/.cursor/skills/`; running scripts |
| [`improvement-log.md`](improvement-log.md) | Optional template for local “what worked” notes |
| [`scripts/docling-convert.py`](scripts/docling-convert.py) | CLI: Markdown / JSON / RAG chunks |
| [`scripts/docling-evaluate.py`](scripts/docling-evaluate.py) | Heuristic quality report on JSON (+ optional Markdown) |
@@ -27,10 +29,6 @@ python3 scripts/docling-evaluate.py /tmp/out.json --markdown /tmp/out.md
Use `--pipeline vlm-local` or `--pipeline vlm-api` for vision-model pipelines; see `SKILL.md` and `pipelines.md`.
## Using as a Cursor / Claude skill
Copy the folder `docling-document-intelligence` into your tool’s skills directory (see [`EXAMPLE.md`](EXAMPLE.md)). The `SKILL.md` frontmatter describes when the skill should activate.
## License
Contributed under the same terms as the [Docling](https://github.com/docling-project/docling) repository (MIT).
MIT (aligned with [Docling](https://github.com/docling-project/docling)).