docs(interfaces): clarify sandbox limits and add "Use external librar…#9800
Open
micaelakaplan wants to merge 1 commit into
Open
docs(interfaces): clarify sandbox limits and add "Use external librar…#9800micaelakaplan wants to merge 1 commit into
micaelakaplan wants to merge 1 commit into
Conversation
…ies & services" page Three gaps in the Interfaces docs, from Ibrahim's proposal: 1. Overview claimed "no external packages / no network access" while the admin settings page documents exactly those (API origins, external scripts). Sandboxing bullets rewritten. 2. Cloud-vs-self-hosted authoring story was undocumented. Create with Agent is Cloud-only; Develop Locally works on any deployment (including air-gapped). Added Availability callout in the overview and a matching note in interfaces-agent.md; positioned Develop Locally as first-class rather than a fallback. 3. No page explained how to use an external library or API, or that calling one and loading one are unlocked in different places. New page interfaces-libraries.md covers the three paths (API origins / external scripts / bundle locally) with a worked point-cloud example and troubleshooting table. - interfaces.md - Sandboxing rewrite + Availability callout - interfaces-agent.md - Cloud-vs-self-hosted callout on the two-ways list - interfaces-local.md - Positioning sentence + expanded troubleshooting row - admin-interfaces.md - Which-section callout at top - interfaces-libraries.md - NEW page (order_enterprise 146) Nav registration is automatic via frontmatter; no _multiconfig.yml or enterprise.yml update needed. Source proposals: https://gist.github.com/IbrahimHS-LSE/afa34366108a9cf6f3e4edf765f60dd8 https://gist.github.com/IbrahimHS-LSE/ea7198f65fd6665d423210993bb2cfd8 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for label-studio-docs-new-theme ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for heartex-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for label-studio-storybook canceled.
|
✅ Deploy Preview for label-studio-playground canceled.
|
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
1 participant
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.
Summary
Applies Ibrahim's proposed Interfaces docs revisions (revisions gist, new-page gist) to close three gaps in the customer-facing Interfaces docs.
The three gaps
Files changed
docs/source/guide/interfaces.mddocs/source/guide/interfaces-agent.mddocs/source/guide/interfaces-local.mdsource did not compiletroubleshooting row to point at the new page.docs/source/guide/admin-interfaces.mddocs/source/guide/interfaces-libraries.mdthree.js) example, troubleshooting table. Ordered atorder_enterprise: 146, immediately after Interface details.Nav registration is automatic via frontmatter (
section: "Interfaces"+order_enterprise); no_multiconfig.yml/enterprise.ymlupdate needed.Follow-up (not blocking this PR)
The new
interfaces-libraries.mdpage makes several implementation-specific claims that would benefit from engineering signoff before we take this out of draft:requireonly resolves a fixed set of built-insevalandblob:web workersconnect-srcvs.script-srcsplit between the two settingsFull engineering checklist (E1–E7) is in the source gist.
Test plan
interfaces-librariesfrom the overview, agent, local, and admin pages🤖 Generated with Claude Code