Repository navigation
docs: dedicated Secrets page, nested under Automations - #182
Merged
Merged
Conversation
Member secrets were only explained inside the automations, CLI and BYOK sections. Add a Secrets page (EN and ES) under Automations in the sidebar (frontmatter parent, after PR gatekeeper) covering: what a secret is and how it is stored, the two kinds (Secret, Provider key) and the base URL rules, managing them from the portal, the CLI (nan secrets) and the API (/v1/secrets: scopes, credentials, idempotency, rate limit), using them in automations (exposures, the GitHub token pattern, BYOK), safety (masking, agent-exposed secrets, write scopes, rotation, replace and delete), limits and a troubleshooting table. Automations, runs (BYOK), nan-cli, webhooks, PR gatekeeper and the intro keep short versions and link the new page; the API reference Secrets tag links it too. Fix runs: masked values show as [masked], not ***. Facts pinned to cloud-api 95414e4, cloud-ui fd930a3, nan-cli 0.1.33 and the Phase 2/3 specs in src/tests/layouts/secretsDocs.test.ts. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…I scopes) - Troubleshooting: exit code 64 is the CLI's generic usage code; the row now says how to recognise the write API case. - Masking: labels and branch names are not rewritten to [masked]; a proposal that would need it is refused (protocol.MaskProposal). - CLI tokens: show/edit/rm look the secret up even by id (secrets:read); a secrets:write-only token can still create. - secret_missing covers any secret deleted after the run was queued. - "A burst of 30", a jump link to Add a secret, ES wording, and the automations Name hint says "usually". - Tests: limits pinned row by row, masking list asserted, every inbound /docs/secrets# anchor checked. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
What
A new Secrets docs page (
/docs/secrets,/es/docs/secrets), nested under Automations in the sidebar (frontmatterparent: automations, right after PR gatekeeper). Until now, member secrets were only explained inside/docs/automations,/docs/nan-cliand the BYOK sections.The page covers:
…a1b2, values of 20+ characters), no hash.generic) and Provider key (provider_key: Anthropic, OpenAI, Google Gemini, OpenAI-compatible), with the base URL rules and the "never put a token in the base URL" warning.nan secrets ls/show/set/edit/rm, values only via--value-file/--value-stdin) and the API (/v1/secrets: routes and scopes, accepted and refused credentials, idempotency, rate limit, the error envelope, the secret object).agentvsactions), reserved names, the read/write GITHUB_TOKEN pattern, BYOK provider keys.[masked], encodings, 8+ character prefix fragments, and its limits), what an agent can do with an agent-exposed secret, why write scopes are dangerous (GitHub write tokens,secrets:write,automations:write,nan auth loginnever inside a workspace), rotation, replace and delete (409 secret_in_use,409 secrets_too_large,secret_missing), Last changed from.Automations, runs (BYOK), nan-cli, webhooks, PR gatekeeper and the intro keep short versions and link the new page. The API reference's Secrets tag and Secret schema now link
/docs/secrets.Also fixes runs: masked values show as
[masked](nan-runmask.Marker), not***.Infrastructure is not disclosed: the page says "encrypted with a key that belongs to your account alone" and never names the secret store (the docs tests forbid it).
Sources of truth
cloud-api origin/main 95414e4 (
internal/secrets,handlers/account_secrets.go,runs/protocol/byok.goandv2.go,nanrun/mask), devopsAGENT-AUTOMATIONS-PHASE2.md§3,AGENT-AUTOMATIONS-PHASE3-BYOK.md§2,AGENT-AUTOMATIONS-PHASE3-WRITE-API.md§2 and §4, cloud-ui fd930a3 (SecretsSection.tsx,SecretAssignments.tsx,lib/inference.ts,lib/updated-by.ts), nan-cli 0.1.33 (cmd/secrets.go).Tests
src/tests/layouts/secretsDocs.test.ts: nesting and order,/api/docsrendering, every link and anchor resolves in the same locale (API anchors against the openapi tags), portal labels, facts pinned to the sources (limits, codes, providers, base URL rules, reserved env names, masking, routes and scopes cross-checked withopenapi.json, the secret object keys), every error in the troubleshooting table, EN/ES parity, no em-dashes, no internals, nothing private, the other guides link it.[masked]fix and the API reference link.npm test: 2383 passed.npm run build: OK.Deploy notes
None: docs only, no env vars, no VERSION file in this repo.
🤖 Generated with Claude Code