docs: fix PRIMER.md relative paths + role.schema.json invalid 'notes' key - #14
Merged
Merged
Conversation
… key - PRIMER.md is at repo root; strip incorrect ../ prefixes on 6 links - schemas/role.schema.json: collapse invalid 'notes' array into '$comment' string (JSON Schema draft-07 has no 'notes' keyword) Cleanup of uncommitted edits found on docs/familiar-contract-launch-readiness worktree; branch was 13 behind main with 0 unique commits, so reset to main + reapplied these two fixes as a clean commit.
There was a problem hiding this comment.
Pull request overview
This PR aims to make two correctness fixes: (1) repair broken relative links in PRIMER.md, and (2) replace an invalid JSON Schema keyword (notes) in schemas/role.schema.json with the draft-07-supported $comment annotation.
Changes:
- Update
schemas/role.schema.jsonto remove the non-standardnoteskeyword and replace it with$comment. - Adjust
PRIMER.mdlink targets to be correct relative to the repository root.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| PRIMER.md | Updates relative links, but currently contains unresolved merge-conflict markers that must be resolved before merge. |
| schemas/role.schema.json | Replaces invalid notes usage with $comment (draft-07-compatible annotation). |
Comments suppressed due to low confidence (1)
PRIMER.md:107
- Unresolved merge-conflict markers (<<<<<<<, =======, >>>>>>>) are present in the "Where to go next" section. This should be resolved before merge; otherwise the rendered docs are corrupted and the PR includes unintended content changes beyond link fixes.
<<<<<<< Updated upstream
- [`rfcs/RFC-0001-familiar-contract.md`](rfcs/RFC-0001-familiar-contract.md) — the normative specification (v0.7.0)
- [`examples/minimal/`](examples/minimal/) — the minimal structurally conformant familiar directory (Lumen)
- [`examples/sage/`](examples/sage/) — a richer structurally conformant familiar directory (Sage)
- `node validators/validate.js ./your-directory` — validate your claimant directory
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+51
to
+61
| <<<<<<< Updated upstream | ||
| **`MEMORY.md`** — the familiar's persistent memory surface. It is required for structural conformance and must also appear on the Ward's protected surface. | ||
|
|
||
| **`ward.toml`** — the governance document. Protected files, editable files, approval tiers. This is what tells the self-improvement loop what it cannot touch. See [`schemas/ward.schema.json`](schemas/ward.schema.json). | ||
|
|
||
| Start from [`examples/minimal/`](examples/minimal/) — that's the floor. [`examples/sage/`](examples/sage/) shows a richer structurally conformant familiar directory. Sage's runtime enforcement lives outside this repo fixture. | ||
| ======= | ||
| **`ward.toml`** — the governance document. Protected files, editable files, approval tiers. This is what tells the self-improvement loop what it cannot touch. See [`schemas/ward.schema.json`](schemas/ward.schema.json). | ||
|
|
||
| Start from [`examples/minimal/`](examples/minimal/) — that's the floor. [`examples/sage/`](examples/sage/) shows a full compliant familiar (Sage is a real familiar running on OpenCoven's infrastructure). | ||
| >>>>>>> Stashed changes |
| "Roles are scoped to a project or context. They are not permanent identity changes.", | ||
| "For the full Roles Architecture, see the OpenCoven roles specification." | ||
| ] | ||
| "$comment": "Roles are additive. A familiar with a role satisfies all five Familiar Contract properties as its baseline; the role adds narrowing constraints. A role cannot override or weaken SOUL.md or IDENTITY.md, cannot expand authority, and is scoped to a project or context rather than a permanent identity change." |
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.
What
Two small correctness fixes found as uncommitted edits on the stale
docs/familiar-contract-launch-readinessworktree. Branch was 13 behind main / 0 ahead, so reset to main + reapplied these two fixes as a clean commit.Changes
../prefixes on 6 relative links. PRIMER.md is at repo root, so../schemas/soul.schema.jsonwas 404-ing; corrected toschemas/soul.schema.json.notesarray into$commentstring. JSON Schema draft-07 has nonoteskeyword;$commentis the correct annotation.Verify
python3 -c "import json; json.load(open('schemas/role.schema.json'))"parses OKNo RFC changes, no schema semantics changes.