docs(sandboxes): document file.parser and deniedDomains in kits spec#25030
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/review |
|
/review |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
The added documentation for file.parser and deniedDomains is accurate, well-structured, and follows the style guide. One minor word-list violation was found in the new content.
|
|
||
| The proxy resolves the credential to `ghp_xyz`, falling back to `GH_TOKEN` if the file is | ||
| missing. If the file exists but the JSON path doesn't resolve, the request fails with the | ||
| parser error below instead of falling back. |
There was a problem hiding this comment.
[MEDIUM] Use "following" instead of "below"
The style guide's word list explicitly requires "following" in place of "below" when referring to content that appears later on the page.
Suggested fix:
the request fails with the following parser error instead of falling back.
The file.parser field had only a one-line description. Adds a dedicated subsection covering supported forms (plain text and json:<dot.path>), JSON path rules and limitations, priority/fallback behaviour for missing files, worked examples, and the common error messages users will encounter. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The deniedDomains field was missing from the network spec table despite being a supported field. Deny rules take precedence over allow rules, including those contributed by other composed kits. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace bold pseudo-headings with a synopsis-led structure: a one-line description of the field's purpose and syntax, a properties table, a single prose paragraph for json: path rules, and two focused examples (plain text and nested JSON with env fallback) instead of four. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The previous wording claimed the proxy falls back when a JSON field is absent. Verified against sandboxd/pkg/secrets/store.go that parser errors propagate; fallback only happens at discovery time based on file presence and env var being set. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
dvdksn
force-pushed
the
docs/sandboxes-kits-file-parser
branch
from
a22ca66 to
486f205
Compare
akristen
left a comment
akristen
left a comment
There was a problem hiding this comment.
Non-blocking, I might add some front matter that shortens the ToC and only lists sections up to h2. Alternatively, as a fast follow maybe breaking out the reference doc into its own kind of thing to shorten length. Users might prefer to have windows side-by-side rather than scrolling baack/forth between concept and reference. If you believe that unravelling it will help users then LGTM.
7 participants
Summary
#### file.parsersubsection under the Credentials spec reference, covering supported forms (json:<dot.path>and plain text), JSON path rules and limitations, priority/fallback behaviour for missing files, worked examples, and common error messages. Behaviour verified againstsandboxd/pkg/secrets/store.go.deniedDomainsto the Network spec reference table, which was missing despite being a supported field. Deny rules take precedence over allow rules including those from composed kits.Test plan
docker buildx bake lint vale— passes clean for this file🤖 Generated with Claude Code