Skip to content

docs(readme): bring in sync with v0.6.0#56

Merged
dvcdsys merged 1 commit into
mainfrom
develop
May 25, 2026
Merged

docs(readme): bring in sync with v0.6.0#56
dvcdsys merged 1 commit into
mainfrom
develop

Conversation

@dvcdsys
Copy link
Copy Markdown
Owner

@dvcdsys dvcdsys commented May 25, 2026

Summary

Doc-only follow-up to the v0.6.0 release — README drifted from reality during the 76-commit develop branch and we missed it in the release PR. No code or behaviour changes.

Findings (and the fix for each)

Drift Fix
Users page: "admin / viewer" "admin / user" (role rename in migration #10)
CIX_WORKSPACES_ENABLED env var still documented Removed — workspaces are always-on since c530d65
GitHub Tokens page listed as "everyone" audience Admin-only (every handler asserts mustBeAdmin)
Dashboard table missing Groups + Managed Tunnels Added both rows (admin audience)
"What you get" missing v0.6.0 features Added bullets: ownership + view-groups, Managed Tunnels, git polling sync
No description of the authorization model New "Authorization model" subsection
cix workspace "<name>" show Actual verb is describe; also added repos
Env-var table missing 6 new v0.6.0 vars Added CIX_SECRET_KEY, CIX_REPOS_DIR, CIX_PUBLIC_URL, CIX_LOG_LEVEL, CIX_DEFAULT_POLL_INTERVAL, CIX_TUNNEL_BIN_MANAGED

Test plan

  • Grep'd README for the four definitely-stale strings (viewer, CIX_WORKSPACES_ENABLED, workspace.*"<name>" show, everyone next to GitHub Tokens) — all gone
  • Cross-checked role names against users.go (RoleAdmin = "admin", RoleUser = "user")
  • Cross-checked workspaces gate against config.go (no WorkspacesEnabled field)
  • Cross-checked GitHub Tokens gating against githubtokens.go (three mustBeAdmin calls)
  • Cross-checked CLI verbs against cli/cmd/workspace.go (list, repos, describe, search)
  • All linked doc files exist: doc/CONFIG_REFERENCE.md, doc/SEARCH_ALGORITHM.md, doc/WEBHOOKS.md, doc/WORKSPACES.md, workspaces.md

🤖 Generated with Claude Code

…, polling

Audit found a handful of post-release drift in README.md that we
missed in the v0.6.0 PR. None of it changes user behaviour; the docs
just stopped describing the actual product:

Role naming
- Users page: "admin / viewer" → "admin / user". The 'viewer' role
  was removed in migration #10; default for new users is 'user'.

Removed feature gates
- CIX_WORKSPACES_ENABLED — workspaces are always-on since c530d65.

Admin-only surfaces that the table marked as "everyone"
- GitHub Tokens page is admin-only (every handler asserts mustBeAdmin).

New v0.6.0 surfaces added to the Dashboard table
- Groups (admin) — view-group membership.
- Managed Tunnels (admin) — Cloudflare / ngrok config + status.

New "What you get" bullets
- Ownership + view-group sharing model.
- Managed Tunnels (Cloudflare + ngrok) for webhook ingress behind NAT.
- Git polling sync as a webhook alternative.

New short "Authorization model" subsection (the README only described
the authentication layer; the access matrix was implicit).

CLI Workspaces command examples
- `cix workspace "<name>" show` → describe (no `show` alias exists).
- Added `repos` verb.

Env-var table additions (and one removal)
- + CIX_SECRET_KEY / _KEYFILE (PAT encryption, auto-keyfile fallback).
- + CIX_REPOS_DIR (workspace clone dir; legacy CIX_WORKSPACES_DATA_DIR alias).
- + CIX_PUBLIC_URL (webhook origin; trumped by live tunnel).
- + CIX_LOG_LEVEL.
- + CIX_DEFAULT_POLL_INTERVAL (polling sync cadence).
- + CIX_TUNNEL_BIN_MANAGED (auto-install Cloudflare/ngrok agent).
- - CIX_WORKSPACES_ENABLED (gate removed).
@dvcdsys dvcdsys merged commit b1c87f4 into main May 25, 2026
5 checks passed
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