Skip to content

docs: align XYPH with Continuum plans and add Edict roadmap#69

Merged
flyingrobots merged 11 commits into
mainfrom
wip/xyph-git-warp-evolution
Jun 21, 2026
Merged

docs: align XYPH with Continuum plans and add Edict roadmap#69
flyingrobots merged 11 commits into
mainfrom
wip/xyph-git-warp-evolution

Conversation

@flyingrobots

@flyingrobots flyingrobots commented Jun 21, 2026

Copy link
Copy Markdown
Owner

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

  • Documentation
    • Updated project documentation with rebranded identity and revised system architecture description
    • Enhanced Quick Start guide featuring updated workflow examples and clearer instructions
    • Added new architectural diagrams illustrating edict processing flow and platform evolution shifts
    • Introduced comprehensive guides on capability-bound operations integration and architectural roadmap

@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@flyingrobots, we couldn't start this review because you've reached your PR review rate limit.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 31c7b44b-76ff-44ad-a1df-b6b5911fc916

📥 Commits

Reviewing files that changed from the base of the PR and between 065eff5 and 4365ddf.

📒 Files selected for processing (4)
  • README.md
  • docs/topics/edict-integration/README.md
  • docs/topics/git-warp-evolution/README.md
  • test/unit/ReadmeOnboardingShape.test.ts
📝 Walkthrough

Walkthrough

The README was rebranded from "Xyph" to "XYPH" and rewritten around Continuum, Edict, and git-warp primitives. Two new roadmap documents were added: xyph-git-warp-evolution.md (four architectural shifts toward decentralized Continuum integration) and xyph-edict-integration.md (Edict integration mandates, governance shifts, and execution model). Supporting Mermaid diagrams and SHA-256 checksums were added, and the README onboarding shape test was updated to match the new heading and quest command.

Changes

XYPH Documentation Rewrite and Roadmap

Layer / File(s) Summary
README rewrite and test alignment
README.md, test/unit/ReadmeOnboardingShape.test.ts
All README sections (title, Why, System Architecture, Quick Start, cockpit, Documentation Map, footer) were replaced under the new XYPH/Continuum/Edict framing; the onboarding shape test was updated to match the new ## Why XYPH? heading and quest task:setup-001 command.
git-warp architectural evolution roadmap
docs/xyph-git-warp-evolution.md
New roadmap document introduces four Core Shifts (bounded quest optics, counterfactual planning strands, signed BTR scrolls, Continuum peer-to-peer treaties), a target src/ layout separating domain services from ports, and phased action items.
Edict integration architecture and mandates
docs/xyph-edict-integration.md
New roadmap document defines Edict's role on the JSONL control plane, cold-path/hot-path execution with a pre-admitted operation registry, three governance Shifts (lawpack-backed intents, bounded autonomous lane, bounded TUI reads), MUST integration mandates, and SHOULD/COULD guidelines.
Supporting diagrams and checksums
docs/diagrams/xyph-edict-sequence.mmd, docs/diagrams/xyph-edict-sequence.mmd.sha256, docs/diagrams/xyph-evolution-shifts.mmd, docs/diagrams/xyph-evolution-shifts.mmd.sha256
New Mermaid sequence diagram for the six-step edict compilation-to-execution flow and a flowchart for the four From/To architectural shifts; both paired with new SHA-256 checksum files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop hop, the README gleams anew,
With Continuum shifts and edicts true.
Cold paths compiled, hot paths run,
HOLMES certifies under the sun.
Git-warp braids each causal strand—
The rabbit stamps it: lawful land! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main objective: aligning XYPH documentation with Continuum plans and adding roadmap documentation for Edict integration and Git-WARP evolution.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch wip/xyph-git-warp-evolution

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between af8c721 and 065eff5.

⛔ Files ignored due to path filters (15)
  • docs/diagrams/cycle-loop.svg is excluded by !**/*.svg
  • docs/diagrams/milestone-lifecycle.svg is excluded by !**/*.svg
  • docs/diagrams/orchestration-fsm.svg is excluded by !**/*.svg
  • docs/diagrams/planning-pipeline.svg is excluded by !**/*.svg
  • docs/diagrams/quest-status-lifecycle.svg is excluded by !**/*.svg
  • docs/diagrams/task-lifecycle.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-cli-context.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-domain-entities.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-hexagonal-arch.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-jsonl-types.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-schema.svg is excluded by !**/*.svg
  • docs/diagrams/teardown-submission-lifecycle.svg is excluded by !**/*.svg
  • docs/diagrams/vision-tenets.svg is excluded by !**/*.svg
  • docs/diagrams/xyph-edict-sequence.svg is excluded by !**/*.svg
  • docs/diagrams/xyph-evolution-shifts.svg is excluded by !**/*.svg
📒 Files selected for processing (8)
  • README.md
  • docs/diagrams/xyph-edict-sequence.mmd
  • docs/diagrams/xyph-edict-sequence.mmd.sha256
  • docs/diagrams/xyph-evolution-shifts.mmd
  • docs/diagrams/xyph-evolution-shifts.mmd.sha256
  • docs/xyph-edict-integration.md
  • docs/xyph-git-warp-evolution.md
  • test/unit/ReadmeOnboardingShape.test.ts

Comment thread README.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread README.md

```bash
npm install
npx tsx xyph-actuator.ts generate-key

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread README.md
Comment on lines +77 to 79
npx tsx xyph-actuator.ts quest task:setup-001 \
--title "Implement git-warp target profile schema" \
--intent intent:setup

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread README.md Outdated
Comment on lines +99 to +103
* [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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread README.md
Comment on lines +18 to +20
* **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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread README.md
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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@flyingrobots flyingrobots merged commit e361bd3 into main Jun 21, 2026
9 checks passed
@flyingrobots flyingrobots deleted the wip/xyph-git-warp-evolution branch June 21, 2026 16:44
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