Skip to content

Commit 4ba5ace

Browse files
committed
Refresh README to match merged PRs
- Drop stale 'literature-lake' framing (kept removing it from prefs help earlier; finally do the same in README prose and the export feature bullet header). - Add bullets for Re-convert (replace) and optional auth, both shipped this batch via #26 and #27. - Rewrite the 'Conversion options reference' paragraph to match the collapsible-disclosure prefs layout from #31 instead of the old flat Conversion / VLM / Enrichments / Advanced layout. - Rewrite the async wait-ceiling section: default is now 0 (unlimited), the ceiling is opt-in, and the settings path is under the Advanced disclosure (not a top-level section). Escalating-failure toasts remain on by default and are mentioned independently. - Fix the duplicated 'Exporting a markdown zip export' header.
1 parent 88d0774 commit 4ba5ace

1 file changed

Lines changed: 30 additions & 19 deletions

File tree

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ pipeline, and attaches the resulting `.md` file back to the same parent item.
1313

1414
---
1515

16-
Designed for **literature-lake** workflows: structured markdown becomes a clean
17-
upstream for note apps, RAG pipelines, citation extraction, summarisation,
18-
literature reviews, and any downstream tool that prefers plain text over PDFs.
16+
Structured markdown makes a clean upstream for note apps, RAG pipelines,
17+
citation extraction, summarisation, literature reviews, and any downstream
18+
tool that prefers plain text over PDFs.
1919

2020
---
2121

@@ -24,8 +24,13 @@ literature reviews, and any downstream tool that prefers plain text over PDFs.
2424
- **One-click conversion**: right-click any PDF attachment (or any parent item
2525
containing PDFs, or any mix of the two) → "Convert with Docling" → Markdown
2626
appears as a sibling attachment.
27+
- **Re-convert (replace)**: right-click → "Re-convert with Docling (replace)"
28+
deletes the existing `.md` sibling and runs conversion again. A confirmation
29+
dialog guards the destructive action (toggleable in prefs).
2730
- **Auto-convert on import** (opt-in): newly imported PDFs are converted
2831
automatically with a 3-second debounce that handles bulk imports gracefully.
32+
- **Optional authentication**: Bearer token / Basic auth / Custom header
33+
schemes for protected `docling-serve` instances. Default is no auth.
2934
- **Full Docling options surfaced**: pipeline (standard / VLM), OCR + language,
3035
table mode, formula / code / chart / picture enrichments, VLM presets, plus
3136
an Advanced JSON escape hatch for anything not in the UI.
@@ -35,7 +40,7 @@ literature reviews, and any downstream tool that prefers plain text over PDFs.
3540
- **Skip-if-exists**: re-running on a parent that already has the corresponding
3641
`.md` siblings skips them (matched by filename, so `paper.pdf` only skips if
3742
`paper.md` exists).
38-
- **Literature-zip export**: right-click a selection (or **Tools → Docling:
43+
- **Markdown `.zip` export**: right-click a selection (or **Tools → Docling:
3944
Export markdown to .zip**) → save a single `.zip` of `{citationKey}.md`
4045
files ready to drop into Obsidian, a RAG indexer, or any downstream
4146
pipeline.
@@ -152,11 +157,13 @@ Then install the `.xpi` via **Tools → Plugins** as above.
152157
4. (Optional) tick **Auto-convert new PDF attachments** in Behavior to run
153158
conversion automatically as you import new PDFs.
154159

155-
A reference of all docling-serve options exposed in the preferences pane (VLM
156-
presets, enrichments, etc.) is in the **Conversion / VLM / Enrichments / Advanced**
157-
sections of the prefs UI itself. Hover any field for inline help.
160+
All docling-serve options exposed in the preferences pane (pipeline, OCR,
161+
VLM presets, enrichments, etc.) live inside two collapsible disclosure
162+
sections — **Conversion options** and **Advanced** — collapsed by default so
163+
the first-run experience stays focused on Server, Behavior, and Output.
164+
Click either header to expand. Hover any field for inline help.
158165

159-
### Exporting a markdown zip export
166+
### Exporting markdown to a .zip
160167

161168
Once a set of items has been converted, you can bundle the markdown into a
162169
single zip for downstream tools:
@@ -206,17 +213,21 @@ Practical consequences:
206213
- Once the upstream cancel API exists, we'll add a cancel button that
207214
actually does what it says.
208215

209-
### Client-side async maxWait (configurable)
210-
211-
Separately from cancel, the async-transport poll loop **does** have an
212-
absolute client-side wait ceiling (`asyncMaxWaitMin`, default 240 minutes,
213-
configurable in **Settings → zotero-docling → Async transport**). When
214-
exceeded, the plugin stops polling and reports an error. This does not
215-
cancel the server-side task — it may still complete in the background —
216-
but it prevents the plugin from spinning forever when docling-serve has
217-
died mid-task. If poll requests start failing repeatedly, a one-time
218-
toast surfaces around the tenth consecutive failure so a dead server
219-
isn't silent.
216+
### Client-side async wait ceiling (opt-in)
217+
218+
The async-transport poll loop runs **without** a client-side time limit by
219+
default — same honesty argument as cancel: docling-serve has no per-task
220+
cancel API, so abandoning a poll just orphans the server task. If you
221+
want a hard ceiling anyway, set **Max wait** to a positive minute value
222+
in **Settings → zotero-docling → Advanced → Async transport** (the
223+
**Advanced** section is collapsed by default; click to expand). When
224+
exceeded, the plugin stops polling and reports an error; the server-side
225+
task may still complete in the background.
226+
227+
Separately, if poll requests start failing repeatedly (server crashed
228+
mid-task, network blip, etc.), a one-time toast surfaces around the
229+
tenth consecutive failure so a dead server isn't silent. This behavior
230+
is always on and doesn't depend on the Max wait setting.
220231

221232
---
222233

0 commit comments

Comments
 (0)