Skip to content

docs: add Docling Interface template to the gallery - #9888

Open
micaelakaplan wants to merge 7 commits into
developfrom
docs/interfaces-docling-template
Open

docs: add Docling Interface template to the gallery#9888
micaelakaplan wants to merge 7 commits into
developfrom
docs/interfaces-docling-template

Conversation

@micaelakaplan

Copy link
Copy Markdown
Contributor

What

Adds a new Docling entry to the Interfaces templates gallery, documenting the DoclingDocument annotation interface (layout regions, reading order, table structure, in-browser OCR, and the live DocLang XML preview).

  • docs/source/templates/interfaces-docling.md — new gallery page (follows the existing interfaces-*.md format: Document AI as the closest model)
  • docs/source/templates/gallery_interfaces.ejs — new Docling card, grouped after Document AI
  • docs/themes/v2/source/images/templates-misc/interface-docling.png — interface screenshot

Why the allowlist emphasis

Unlike most templates, this interface loads two libraries from public CDNs at runtime, so it won't work until an Owner/Admin allowlists those hosts. The page leads with this:

  • An error callout up top pointing to the allowlist section
  • A dedicated "Before you start: allowlist the required domains" section covering:
    • Whathttps://cdn.jsdelivr.net (DocLang viewer / preview) and https://unpkg.com (Tesseract.js / in-browser OCR)
    • Why — the Interfaces sandbox blocks outbound network by CSP
    • Where — Organization > Settings > Interfaces, added to both Advanced: external scripts (script-src) and API origins (connect-src)
    • Cross-links to the Interface admin settings and Use external libraries and services guides

Notes

  • Source of truth for the interface's params, labels, result shape, and required domains is the latest Docling interface (interface Relative paths to .js files #332 / source v35).
  • Needs a docs preview / rendering check before merge.

🤖 Generated with Claude Code

Adds a new Docling entry to the Interfaces templates gallery, documenting
the DoclingDocument annotation interface (layout regions, reading order,
table structure, in-browser OCR, live DocLang XML preview).

Emphasizes up front that two CDN hosts (cdn.jsdelivr.net for the DocLang
viewer, unpkg.com for Tesseract.js OCR) must be added to the org
Interfaces allowlist under both "Advanced: external scripts" (script-src)
and "API origins" (connect-src), since the interface loads them at runtime.

- docs/source/templates/interfaces-docling.md: new gallery page
- docs/source/templates/gallery_interfaces.ejs: new Docling card
- interface-docling.png: interface screenshot

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for label-studio-docs-new-theme canceled.

Name Link
🔨 Latest commit 716d517
🔍 Latest deploy log https://app.netlify.com/projects/label-studio-docs-new-theme/deploys/6a871a19c45696000810440f

@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for heartex-docs canceled.

Name Link
🔨 Latest commit 716d517
🔍 Latest deploy log https://app.netlify.com/projects/heartex-docs/deploys/6a871a195755e00008a33714

@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for label-studio-storybook canceled.

Name Link
🔨 Latest commit 716d517
🔍 Latest deploy log https://app.netlify.com/projects/label-studio-storybook/deploys/6a871a19fb4ed100081e3299

@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for label-studio-playground canceled.

Name Link
🔨 Latest commit 716d517
🔍 Latest deploy log https://app.netlify.com/projects/label-studio-playground/deploys/6a871a194b06070008a3d5e8

@github-actions github-actions Bot added the docs label Aug 6, 2026
Add a "Part of the Docling ecosystem" note near the top: links to the
Docling project docs, the Docling ML backend example (auto pre-labeling),
and IBM Docling SaaS / Workbench as the hosted conversion service.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
micaelakaplan and others added 5 commits August 18, 2026 12:06
Reflect the docling -> doclang rename made in the interface (hs-platform
PR 2098): rename the doc slug + screenshot to interfaces-doclang, update
the gallery entry, rename the result controls (docling -> doclang, and the
DocLang XML control doclang -> doclang_xml), and relabel the preview tab
"DocLang" -> "xml".

Point the Docling toolkit/Workbench links at the new website https://docling.ai
and the IBM Docling SaaS reference at https://www.ibm.com/products/docling.
IBM Docling library/type references (DoclingDocument, the Docling toolkit,
ecosystem, and ML backend) are left unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The "Interface admin settings" and "external libraries" links used bare
slugs, which resolve under /templates/ and 404 since the target pages
live under /guide/. Point them at /guide/admin-interfaces and
/guide/interfaces-libraries. Fixes the check_links CI failure.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The Docling template page renders on the open-source docs site, but
admin-interfaces and interfaces-libraries are tier: enterprise pages that
aren't built there, so /guide/... resolved to 404 in the link checker.
Point them at https://docs.humansignal.com/guide/... — the same
absolute-URL convention other OS pages use to reference enterprise docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant