docs: onboarding golden-path docs + agent config reference (bd openlock-lvc.4, lvc.5)#57
Merged
Conversation
…d openlock-lvc.4)
…d openlock-lvc.5)
…drift maintenance note (bd openlock-lvc.5)
…den path (bd openlock-lvc.4)
… note sandbox needs .openlock/ (bd openlock-lvc.4)
…-guarded (bd openlock-lvc.5)
… harness (legacy bool), version required (bd openlock-lvc.5)
… (bd openlock-lvc.4)
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.
Closes the onboarding golden-path epic (openlock-lvc) — the discovery half: human docs (lvc.4) + an agent-facing config reference (lvc.5).
What changed
docs/is now tracked/public; local-only artifacts (spikes, recipes, superpowers specs/plans) moved to a gitignored.local/. (.gitignoreflip only —CLAUDE.mdis locally git-excluded by design, so its preference note isn't in the diff.)docs/.docs/reference pages:installation,sessions,mounts,policies,security, plus adocs/README.mdindex — the dense prose moved out of the README.docs/agent-config-reference.md(harness-agnostic, machine-loadable: full.openlockconfig + policy schema, internals, and a{harness, provider, project files} → configdecision procedure) + a thin rootllms.txtindex.config-corenow exportsknownConfigTokens();src/agent-reference-drift.test.tsasserts 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)
caps: [js]examples —capsis a rejected legacy manifest key.validate-policy→validate; addedlogout/providers/refs/report/complete; restoredupdate-images [--no-cache].docs/policies.md: dropped fictionaldefault-js/py/js-py.yaml+ "detected capabilities" model → policy lives at.openlock/policy.yamlviaopenlock init.docs/sessions.md:clean --staleactually removes exited+missing (idle-stale semantics belong toreap).network_policiesis a mapping (not array); binaryharnessis a deprecated boolean;versionis required.Tests
bun run lint/typecheck/knipclean; 744 openlock unit tests pass (incl. the new drift guard). The only local test failure is a vendored z3 JS test inside the gitignoredopenshell-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.