docs: align XYPH with Continuum plans and add Edict roadmap#69
Conversation
…architecture critiques
|
Warning Review limit reached
More reviews will be available in 46 minutes and 59 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe README was rebranded from "Xyph" to "XYPH" and rewritten around Continuum, Edict, and git-warp primitives. Two new roadmap documents were added: ChangesXYPH Documentation Rewrite and Roadmap
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 99-107: All documentation links in the README.md file use absolute
machine-specific file:// URLs (containing /Users/james/git/xyph/) that will not
work for other users or in CI/CD environments. Replace each of these absolute
file:// URLs with relative markdown links that reference the correct file paths
within the repository, for example change file:///Users/james/git/xyph/GUIDE.md
to ./GUIDE.md, file:///Users/james/git/xyph/docs/canonical/ARCHITECTURE.md to
./docs/canonical/ARCHITECTURE.md, and similarly for all other documentation
references in the Documentation Map section.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8772536d-f077-4c94-a505-108a98ee18db
⛔ Files ignored due to path filters (15)
docs/diagrams/cycle-loop.svgis excluded by!**/*.svgdocs/diagrams/milestone-lifecycle.svgis excluded by!**/*.svgdocs/diagrams/orchestration-fsm.svgis excluded by!**/*.svgdocs/diagrams/planning-pipeline.svgis excluded by!**/*.svgdocs/diagrams/quest-status-lifecycle.svgis excluded by!**/*.svgdocs/diagrams/task-lifecycle.svgis excluded by!**/*.svgdocs/diagrams/teardown-cli-context.svgis excluded by!**/*.svgdocs/diagrams/teardown-domain-entities.svgis excluded by!**/*.svgdocs/diagrams/teardown-hexagonal-arch.svgis excluded by!**/*.svgdocs/diagrams/teardown-jsonl-types.svgis excluded by!**/*.svgdocs/diagrams/teardown-schema.svgis excluded by!**/*.svgdocs/diagrams/teardown-submission-lifecycle.svgis excluded by!**/*.svgdocs/diagrams/vision-tenets.svgis excluded by!**/*.svgdocs/diagrams/xyph-edict-sequence.svgis excluded by!**/*.svgdocs/diagrams/xyph-evolution-shifts.svgis excluded by!**/*.svg
📒 Files selected for processing (8)
README.mddocs/diagrams/xyph-edict-sequence.mmddocs/diagrams/xyph-edict-sequence.mmd.sha256docs/diagrams/xyph-evolution-shifts.mmddocs/diagrams/xyph-evolution-shifts.mmd.sha256docs/xyph-edict-integration.mddocs/xyph-git-warp-evolution.mdtest/unit/ReadmeOnboardingShape.test.ts
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 065eff5fbc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| npm install | ||
| npx tsx xyph-actuator.ts generate-key |
There was a problem hiding this comment.
Generate the key after selecting the identity
In a fresh checkout with no saved identity, this line runs before login human.ada, so generate-key resolves the default agent.prime identity and writes the Guild Seal key for that principal. The next line persists human.ada, leaving the documented participant without a private key for later seal/settlement commands; swap the order or pass --as human.ada when generating the key.
Useful? React with 👍 / 👎.
| npx tsx xyph-actuator.ts quest task:setup-001 \ | ||
| --title "Implement git-warp target profile schema" \ | ||
| --intent intent:setup |
There was a problem hiding this comment.
Make the quick-start quest claimable
In a fresh checkout, copying this block does not produce a claimable quest: src/cli/commands/ingest.ts registers quest with a required --campaign <id> option and creates the node with status PLANNED, while src/cli/commands/coordination.ts rejects claim unless the quest is already READY. As written, the quick start exits at the missing option, and even after adding it the later claim fails unless the flow also satisfies readiness and runs ready first.
Useful? React with 👍 / 👎.
| * [GUIDE.md](file:///Users/james/git/xyph/GUIDE.md) — Orientation, Digital Guild nouns, and quick checklist. | ||
| 2. **The Bedrock**: | ||
| * [ARCHITECTURE.md](file:///Users/james/git/xyph/docs/canonical/ARCHITECTURE.md) — Authoritative structural references (Hexagonal, Ports, WARP). | ||
| * [docs/VISION.md](file:///Users/james/git/xyph/docs/VISION.md) — Stigmergic tenets and the mission. | ||
| * [METHOD.md](file:///Users/james/git/xyph/docs/canonical/METHOD.md) — Work doctrine and cycle loops. |
There was a problem hiding this comment.
Use repository-relative documentation links
These file:///Users/james/... URLs only work on the author's machine and render as external file links for readers of the public README instead of navigating the repository. The map also sends METHOD.md to docs/canonical/METHOD.md even though the repository path is the root METHOD.md, so readers hit dead links; use relative paths such as ./GUIDE.md, ./ARCHITECTURE.md, and ./METHOD.md.
Useful? React with 👍 / 👎.
| * **Edict Execution Sandbox**: Planning changes and graph mutations are written as **Edict Intents**—safe, statically verified operations. Edict contains the authority blast radius of prompt injections by proving exactly which graph nodes can be touched before code runs. | ||
| * **Coordination-Free Concurrency**: Built on [git-warp](https://github.com/git-stunts/git-warp), XYPH coordinates concurrent agent claims offline-first. Diverging worldlines are converged deterministically by Last-Write-Wins (LWW) CRDT semantics, or reconciled via explicit sequenced admission. | ||
| * **Cryptographic Settlement**: Quests are sealed with **Scrolls**—cryptographically signed Boundary Transition Records (BTRs). Peer participants or human operators verify quest resolution by inspecting the Scroll's self-contained signature envelope, without needing to walk or download the full repository history. |
There was a problem hiding this comment.
Mark target runtime guarantees as future work
These bullets describe Edict intents, BTR scroll verification, and related runtime behavior as if they work today, but the roadmap docs added in this same change state that Edict Core IR/lowerers/admission/runtime execution and BTR-style scrolls are future work (docs/xyph-edict-integration.md:5, docs/xyph-git-warp-evolution.md:4). In the public README this will send users looking for runtime support and verification guarantees that the CLI cannot provide yet; keep these claims explicitly future-conditional or move them under the roadmap warning.
Useful? React with 👍 / 👎.
| In a post-Unix architecture, files are not fundamental; they are bounded, materialized readings over causal history. XYPH applies this tenet to coordination: | ||
|
|
||
| ## Quick Start | ||
| * **Verifiable Causal Sovereignty**: Every quest or backlog item is linked back to a human-authorized root node through the **Genealogy of Intent**. AI agents cannot hallucinate work; they can only claim and act on cryptographically signed, authorized tasks. |
There was a problem hiding this comment.
Don't state backlog items are intent-linked
For items created through the documented intake path, inbox writes a BACKLOG task with suggested_by metadata but no authorized-by edge, and the renderer explicitly treats BACKLOG tasks as genuinely lacking an intent until promotion. Saying every backlog item is linked to a human-authorized root makes unaudited suggestions look sovereign before the promote step; scope this claim to promoted/planned quests or document the triage exception.
Useful? React with 👍 / 👎.
This PR overhauls the root README to align with Continuum participant plans, registers the Git-WARP evolution and Edict integration design roadmaps, and implements the supporting architecture diagram.
Summary by CodeRabbit