Skip to content

docs: onboarding golden-path docs + agent config reference (bd openlock-lvc.4, lvc.5)#57

Merged
vessux merged 9 commits into
mainfrom
feat/onboarding-docs-lvc
May 31, 2026
Merged

docs: onboarding golden-path docs + agent config reference (bd openlock-lvc.4, lvc.5)#57
vessux merged 9 commits into
mainfrom
feat/onboarding-docs-lvc

Conversation

@vessux
Copy link
Copy Markdown
Owner

@vessux vessux commented May 31, 2026

Closes the onboarding golden-path epic (openlock-lvc) — the discovery half: human docs (lvc.4) + an agent-facing config reference (lvc.5).

What changed

  • Repo reorg: docs/ is now tracked/public; local-only artifacts (spikes, recipes, superpowers specs/plans) moved to a gitignored .local/. (.gitignore flip only — CLAUDE.md is locally git-excluded by design, so its preference note isn't in the diff.)
  • README slimmed 342 → 141 lines into a golden-path landing: install → doctor → init → validate → sandbox, with an accurate command cheatsheet and links into docs/.
  • New docs/ reference pages: installation, sessions, mounts, policies, security, plus a docs/README.md index — the dense prose moved out of the README.
  • New docs/agent-config-reference.md (harness-agnostic, machine-loadable: full .openlock config + policy schema, internals, and a {harness, provider, project files} → config decision procedure) + a thin root llms.txt index.
  • Drift guard: config-core now exports knownConfigTokens(); src/agent-reference-drift.test.ts asserts the agent reference documents every config key/enum the validators recognize (55/55). Adding a schema field without documenting it now fails CI.

Correctness fixes folded in (stale text the old README carried)

  • Removed caps: [js] examples — caps is a rejected legacy manifest key.
  • Command table: validate-policyvalidate; added logout/providers/refs/report/complete; restored update-images [--no-cache].
  • docs/policies.md: dropped fictional default-js/py/js-py.yaml + "detected capabilities" model → policy lives at .openlock/policy.yaml via openlock init.
  • docs/sessions.md: clean --stale actually removes exited+missing (idle-stale semantics belong to reap).
  • agent reference: network_policies is a mapping (not array); binary harness is a deprecated boolean; version is required.

Tests

bun run lint / typecheck / knip clean; 744 openlock unit tests pass (incl. the new drift guard). The only local test failure is a vendored z3 JS test inside the gitignored openshell-fork/ sibling — absent in CI.

Deferred follow-ups (out of scope): README "How it works" still describes the pre-init capability-detection model; Claude Code skill packaging for the decision procedure.

@vessux vessux merged commit e9c0d5c into main May 31, 2026
5 checks passed
@vessux vessux deleted the feat/onboarding-docs-lvc branch May 31, 2026 18:32
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