Skip to content

Bring the docs, changelog and chart version in line for a release - #520

Merged
davidmckayv merged 1 commit into
mainfrom
docs/release-prep
Sep 13, 2026
Merged

Bring the docs, changelog and chart version in line for a release#520
davidmckayv merged 1 commit into
mainfrom
docs/release-prep

Conversation

@davidmckayv

Copy link
Copy Markdown
Contributor

Pre-release sweep. Every doc validated against the code; the real drift is fixed and the CHANGELOG ## Unreleased is reconciled against everything merged since v0.0.9.

Docs

  • README Main surfaces table: added /routines, /admin/skills, /admin/people, /admin/identity-providers; corrected the /admin/plugins description.
  • configuration.md five required vars (not three); documented AGENT_BOT_MODEL, BOT_REASONING_EFFORT, OPENAI_CONTAINER_BASE_URL; fixed a broken table column; disambiguated COMPUTER_SANDBOX from the cluster sandbox provider.
  • architecture.md added the command policy field and the agent-harness service.
  • coworkers.md noted the appended provenance block.
  • development.md openssl/npx prerequisites and the routine worker in the start summary.
  • releasing.md the two gating CI jobs the checks table omitted; the release PR now carries three changes.
  • deployment.md removed the desktop folder-access section (the desktop app is unreleased).
  • plugins/google-drive.md rewritten for the REST API the connector actually uses (was documenting the abandoned MCP setup).

CHANGELOG

## Unreleased now covers the file-attachment fix, the LangGraph refusal feedback, and the validation-hardening sweep, with the component decision-function fail-open called out.

Chart version

The default image tag was the bare appVersion (0.0.4), but published tags carry a v and 0.0.4 predates the first startable release, so a default helm install sat in ImagePullBackOff. Now: appVersion tracks the released version (0.0.9), the tag helper prefixes v, the release workflow moves appVersion with package.json every release, and CI refuses a tree where the two have drifted.

Validated every doc against the code and fixed the drift found:

- README: the Main surfaces table was missing /routines, /admin/skills,
  /admin/people and /admin/identity-providers, and described /admin/plugins
  as configuring deployment skills, which it no longer does.
- configuration.md: five required vars, not three; documented AGENT_BOT_MODEL,
  BOT_REASONING_EFFORT and OPENAI_CONTAINER_BASE_URL; fixed a broken table
  column; distinguished COMPUTER_SANDBOX from the cluster sandbox provider.
- architecture.md: added the command policy field and the agent-harness service.
- coworkers.md: noted the provenance block the deployment appends to the
  standing role.
- development.md: openssl and npx prerequisites, and the routine worker in the
  start.sh summary.
- releasing.md: the two gating CI jobs the checks table omitted; the release PR
  now carries three changes.
- deployment.md: removed the desktop folder-access section; the desktop app is
  not released.
- plugins/google-drive.md: rewritten for the REST API the connector actually
  uses, replacing the abandoned MCP setup, troubleshooting and enrolment steps.

CHANGELOG: added the validation-hardening sweep that had no entry yet
(agent tool-call, policy dry-run and audit-event limits, component publication,
sandboxed fields, catalogue entries, the four human-input gestures), calling out
the component decision-function fail-open; dropped the desktop question-box
entry, since the desktop app is not released.

Chart version: the default image tag was the bare appVersion (0.0.4), but
published tags carry a v and 0.0.4 predates the first startable release, so a
default helm install sat in ImagePullBackOff. appVersion now tracks the released
version (0.0.9), the tag helper prefixes v to name a tag that exists, the release
workflow moves appVersion with package.json every release, and CI refuses a tree
where the two have drifted.
@davidmckayv
davidmckayv merged commit 55636f2 into main Sep 13, 2026
16 checks passed
@davidmckayv
davidmckayv deleted the docs/release-prep branch September 13, 2026 17:20
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