-
Notifications
You must be signed in to change notification settings - Fork 0
Clarify Rally value prop and architecture ownership in docs #19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| Read `~/configs/GLOBAL-AGENTS.md` (fallback: https://raw.githubusercontent.com/justinmoon/configs/master/GLOBAL-AGENTS.md). Skip if both unavailable. | ||
|
|
||
| # Rally Agent Notes | ||
|
|
||
| ## Product Goal | ||
|
|
||
| Rally coordinates multi-agent coding sessions by giving each agent one actionable instruction at a time. | ||
|
|
||
| Use Rally when protocol adherence matters more than free-form collaboration. | ||
|
|
||
| ## Architecture Ownership | ||
|
|
||
| - Core (`src/` + `crates/rally-core`) owns session lifecycle, persistence, locking, and dispatch. | ||
| - Workflow crates (`crates/rally-workflow-*`) own typed workflow state, transitions, and workflow-specific instructions. | ||
| - Wrapper templates (`prompts/`) own `/rally` wrapper behavior only (argument resolution + loop bootstrap). | ||
|
|
||
| ## Practical Rules | ||
|
|
||
| - Keep workflow-specific instruction/policy text in workflow crates. | ||
| - Keep wrapper templates workflow-agnostic. | ||
| - If you add/rename a run command, update wrapper-facing docs (`README.md`, `docs/skill-install-run.md`) in the same 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,60 @@ | ||
| # Rally | ||
|
|
||
| Step-by-step coordinator for multi-agent coding sessions. | ||
| Rally is a turn-based coordinator for multi-agent coding sessions. | ||
|
|
||
| ## Skill Wrappers | ||
| Its core job is simple: each agent polls for work and gets one clear instruction at a time. | ||
|
|
||
| Rally now provides a wrapper-oriented command surface: | ||
| ## Why It Exists | ||
|
|
||
| - `rally skill install --target <codex|droid|pi|claude-code|all>` | ||
| - `rally skill run ...` (canonical wrapper entrypoint) | ||
| - `rally skill exec ...` (alias for `run`) | ||
| - `rally skill agent-howto ...` (prints the current detailed agent loop instructions) | ||
| - `rally skill doctor --target ...` | ||
| - `rally skill uninstall --target ...` | ||
| Rally helps agents follow pre-existing workflows without improvising protocol. | ||
|
|
||
| Install wrappers everywhere: | ||
| - keeps each agent on a strict loop (`next` -> do work -> `done`) | ||
| - reduces prompt ambiguity by issuing concrete next actions | ||
| - preserves workflow state and transitions centrally | ||
|
|
||
| ```bash | ||
| rally skill install --target all | ||
| ``` | ||
| ## Extension Model | ||
|
|
||
| Installed `/rally` wrappers are thin adapters that delegate back to Rally core: | ||
| Today, workflow extension is **build-time**: | ||
|
|
||
| ```bash | ||
| rally skill agent-howto "$@" | ||
| ``` | ||
| - workflows are registered in Rust via `WorkflowRegistry` | ||
| - built-ins are wired in `src/main.rs` | ||
| - workflow behavior/state lives in workflow crates under `crates/` | ||
|
|
||
| ## /rally Usage | ||
| Runtime plugin workflows are planned but not shipped yet. See [todos/runtime-workflows-final.md](todos/runtime-workflows-final.md). | ||
|
|
||
| Typical wrapper invocations: | ||
| ## Architecture Boundaries | ||
|
|
||
| - `/rally` | ||
| - `/rally build` | ||
| - `/rally build reviewer` | ||
| - `/rally <invite-code>` | ||
| - Rally core owns session envelope, persistence, locking, and dispatch. | ||
| - Workflow crates own workflow state schemas, transitions, and workflow-specific instruction text. | ||
| - Wrapper prompts in `prompts/` are for `/rally` command resolution and loop bootstrap only. | ||
|
|
||
| `rally skill run` resolves context in this order: | ||
| If prompt text is specific to a workflow's behavior, keep it in the workflow crate, not in wrapper templates. | ||
|
|
||
| 1. explicit args (`--session`, `--as`, positional selectors) | ||
| 2. invite token input | ||
| 3. saved local workspace context | ||
| 4. interactive prompt fallback | ||
| ## Skill Wrappers | ||
|
|
||
| ## Troubleshooting | ||
| Install wrappers: | ||
|
|
||
| Use doctor to inspect path/status per target: | ||
| ```bash | ||
| rally skill install --target all | ||
| ``` | ||
|
|
||
| Canonical wrapper entrypoint: | ||
|
|
||
| ```bash | ||
| rally skill run ... | ||
| ``` | ||
|
|
||
| Alias: | ||
|
|
||
| ```bash | ||
| rally skill doctor --target all | ||
| rally skill exec ... | ||
| ``` | ||
|
|
||
| For details and target path mapping, see [docs/skill-install-run.md](docs/skill-install-run.md). | ||
| Wrapper helpers: | ||
|
|
||
| - `rally skill agent-howto ...` | ||
| - `rally skill context` | ||
| - `rally skill doctor --target ...` | ||
| - `rally skill uninstall --target ...` | ||
|
|
||
| For install/run details, see [docs/skill-install-run.md](docs/skill-install-run.md). | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 AGENTS.md rule violation:
rally skill contextadded to README.md without updating docs/skill-install-run.mdThe PR adds
rally skill contextto the README's wrapper-helpers list (line 56), butdocs/skill-install-run.mdis not updated in the same change. This violates the AGENTS.md practical rule: "If you add/rename a run command, update wrapper-facing docs (README.md,docs/skill-install-run.md) in the same change." The old README (git show HEAD~1:README.md) did not listrally skill context, anddocs/skill-install-run.mdhas zero mentions ofskill context— confirmed via grep.Prompt for agents
Was this helpful? React with 👍 or 👎 to provide feedback.