Skip to content

docs(darwin): agent-developer guide for the hardening policy#209

Open
ciphr wants to merge 1 commit into
mainfrom
vin/docs-darwin-hardening-policy-guide
Open

docs(darwin): agent-developer guide for the hardening policy#209
ciphr wants to merge 1 commit into
mainfrom
vin/docs-darwin-hardening-policy-guide

Conversation

@ciphr

@ciphr ciphr commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

What

A new Agent Developer Guide: Steer how Darwin hardens your agent — at developer-guide/adapt/hardening-policy.mdx.

It documents the HardeningPolicy feature (shipped across DAR-14/15/16/17) for developers who run Darwin as a module in their own Kubernetes cluster: how to attach a policy to an evolution job over REST and via the SDK, the full policy schema, the None = default-behavior contract, and the extra="forbid" validation.

For the tech-write review

This is not ready to publish as-is — it needs your review on three things I deliberately left for you:

  1. Information architecture / placement. There is no Darwin section in developer-guide/ on main yet (it has evaluate and protect, but nothing for the adapt/improve stage). I placed this under a new developer-guide/adapt/ directory as a proposal. Move/rename as the IA dictates.
  2. Navigation. The page is not registered in docs.json, so it will not appear in the sidebar. Decide its nav group when you settle placement.
  3. Release gating. Darwin-as-an-SDK-module is pre-release. You may want to gate this as .draft.mdx (excluded from the build per the repo's draft convention) until the feature ships.

Vale was not run — it is not installed in my environment. I applied the documented VijilStyle rules by hand (Title Case headings, no contractions, H2/H3 only, component naming), but please run vale developer-guide/adapt/hardening-policy.mdx as the authoritative check.

Substance verification (done)

Every code example and factual claim was traced to shipped source before writing — no fabrication:

  • Schema (fields, types, defaults, validators) against vijil-darwin origin/main dc595d1 — which includes DAR-16, so the extra="forbid" / "typos fail loud" claim is true.
  • REST: POST /v1/evolutions request body + 202 CreateJobResponse + the genome prerequisite, against api/routes/jobs.py.
  • SDK: the EvolutionsGeneratedResource + VijilHTTP call path, and the caveat that client.jobs routes through the Console (not Darwin-direct), against vijil-sdk.
  • In-cluster URL: service-darwin against the Helm chart.
  • Transient policy / restart behavior against postgres_job_repository._to_row.

A two-reviewer steelman pass against the docs rubric returned PASS after this verification. (An earlier pass false-flagged the schema because it read a stale local checkout; syncing to origin/main resolved it — the doc matches shipped code.)

Do not merge

Hold for tech-writer review + a release-timing decision.

🤖 Generated with Claude Code

Persona: Agent Developer. Type: Guide.
Path: developer-guide/adapt/hardening-policy.mdx

Documents the HardeningPolicy feature (DAR-14/15/16/17) for developers
who run Darwin as a module in a Kubernetes cluster: attaching a policy to
an evolution job over REST and via the SDK, the policy schema
(attribution / mutation / tradeoff sub-policies), None = default behavior,
and the extra="forbid" validation.

Every code example and claim was verified against shipped source:
vijil-darwin origin/main (dc595d1, includes DAR-16's extra="forbid") and
vijil-sdk main — schema fields/defaults/validators, the POST /v1/evolutions
request and 202 response, the SDK call path, and the service-darwin
in-cluster URL. Steelman docs-rubric review: PASS.

Vale style applied by hand (Title Case headings, no contractions,
component naming) — Vale is not installed locally, so CI / the tech-write
review should run it. The page is intentionally NOT registered in
docs.json navigation and the placement under developer-guide/adapt/ is a
proposal: IA, nav, and release gating (the feature is pre-release) are
left for the tech-writer review.

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

mintlify Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
vijil 🟢 Ready View Preview Jun 13, 2026, 4:40 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant