Skip to content

docs: align public repo naming with v95 surfaces#42

Merged
squaeragent merged 3 commits into
mainfrom
codex/v95-public-repo-docs
May 16, 2026
Merged

docs: align public repo naming with v95 surfaces#42
squaeragent merged 3 commits into
mainfrom
codex/v95-public-repo-docs

Conversation

@squaeragent
Copy link
Copy Markdown
Contributor

@squaeragent squaeragent commented May 15, 2026

Summary

  • Align high-visibility public repo copy with v95 surface naming: ZERO Runtime, operator Control, Proof, Developers.
  • Add canonical links from the public repo README to getzero.dev/developers and getzero.dev/proof.
  • Regenerate docs/llms-full.txt so agent retrieval stops carrying stale public control plane and product-page wording.
  • Extend public-readiness to catch stale current-surface wording in README/AGENTS/high-visibility docs.

Guardrails

  • Docs/gate only.
  • No runtime code changes.
  • No live Runtime, trading, order, cancel, credential, or deployment behavior changes.
  • Existing compatibility command names like /cockpit-mode, /live/cockpit, and live-cockpit remain documented where they are actual current CLI/API names.

Validation

  • just public-readiness
  • just public-proof
  • just registry-readiness
  • scripts/generate_llms_full.py --check

Summary by CodeRabbit

  • Documentation

    • Clarified open-core boundary documentation with refined terminology regarding product constraints and hosted service requirements.
    • Updated runtime naming and control surface documentation labels for consistency.
  • Style

    • Updated user interface display text from "Live Cockpit" to "Live Control" in the control surface.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1614810d-0d67-43ab-8034-4c64cdf30df1

📥 Commits

Reviewing files that changed from the base of the PR and between 896d2e1 and 93830da.

📒 Files selected for processing (8)
  • AGENTS.md
  • README.md
  • cli/crates/zero-tui/src/widgets/pane.rs
  • cli/crates/zero-tui/tests/snapshots.rs
  • docs/llms-full.txt
  • docs/llms.txt
  • docs/open-core-boundary.md
  • scripts/public_readiness_gate.sh
✅ Files skipped from review due to trivial changes (4)
  • docs/llms.txt
  • AGENTS.md
  • cli/crates/zero-tui/src/widgets/pane.rs
  • docs/open-core-boundary.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • scripts/public_readiness_gate.sh
  • cli/crates/zero-tui/tests/snapshots.rs
  • README.md

📝 Walkthrough

Walkthrough

This PR refreshes product positioning terminology by replacing "ZERO-hosted control plane" with "ZERO-hosted app" throughout documentation, README, and UI, while renaming "cockpit" references to "Control." It also adds a surface-limited validation helper to the public readiness gate to enforce boundary compliance.

Changes

Terminology refresh and boundary validation updates

Layer / File(s) Summary
Core open-core boundary terminology updates
AGENTS.md, README.md, docs/open-core-boundary.md
Replaces "ZERO-hosted control plane" with "ZERO-hosted app" in agent runtime constraints, README boundary statement, and open-core-boundary.md rules; renames "Local engine runtime" to "Local ZERO Runtime."
TUI text and snapshot updates
cli/crates/zero-tui/src/widgets/pane.rs, cli/crates/zero-tui/tests/snapshots.rs
Updates CockpitPane header and missing-data placeholder from "live cockpit" to "live control," and updates the snapshot test assertion accordingly.
Documentation index and generated bundle synchronization
docs/llms.txt, docs/llms-full.txt
Updates navigation label from "Live Cockpit" to "Live Control" in doc index and propagates all terminology changes to the generated LLM context bundle.
Public readiness script validation helper
scripts/public_readiness_gate.sh
Adds current_surface_search() helper to limit keyword searches to a fixed allowlist of surface documentation files with rg/grep fallback, and extends public product honesty checks to detect boundary-violation keywords.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A cockpit becomes Control, a plane becomes an app,
The docs now sing in harmony—no terminology gap!
With surface-deep searches and snapshots aligned,
The product stands clearer, more crisp, more refined. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 20.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: align public repo naming with v95 surfaces' clearly describes the main change—updating documentation terminology to align with v95 naming conventions.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/v95-public-repo-docs

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.

@squaeragent squaeragent marked this pull request as ready for review May 15, 2026 19:36
Copy link
Copy Markdown

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

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: cffe25cc2f

ℹ️ 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 Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 `@scripts/public_readiness_gate.sh`:
- Around line 31-48: current_surface_search() must fail closed on file errors:
after running rg or grep, capture the command's exit code and if it indicates an
error (for rg/grep an exit code >1 or ==2), write an explanatory message to
stderr and exit the script (or return a distinct non-zero code) so the gate
fails instead of silently treating the error as “no match”; otherwise
preserve/return the original exit code so callers can distinguish “no match” (1)
from an actual error. Reference the current_surface_search function and update
both the rg and grep branches to implement this exit-code check and error
handling.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9a9e82b-173d-4bca-832d-b3f308a7d601

📥 Commits

Reviewing files that changed from the base of the PR and between c23232b and cffe25c.

📒 Files selected for processing (7)
  • AGENTS.md
  • README.md
  • docs/llms-full.txt
  • docs/llms.txt
  • docs/open-core-boundary.md
  • docs/positioning.md
  • scripts/public_readiness_gate.sh

Comment thread scripts/public_readiness_gate.sh
@squaeragent squaeragent force-pushed the codex/v95-public-repo-docs branch from 896d2e1 to 93830da Compare May 16, 2026 05:34
@squaeragent squaeragent merged commit 4701cab into main May 16, 2026
29 checks passed
@squaeragent squaeragent deleted the codex/v95-public-repo-docs branch May 16, 2026 05:37
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