39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
|
# SCOPE
|
||
|
|
|
||
|
|
> Lightweight boundary for agents and contributors.
|
||
|
|
|
||
|
|
## One-liner
|
||
|
|
|
||
|
|
ralph-workplan is a Claude Code skill/plugin that runs a Ralph Loop scoped to a Markdown workplan file, automatically stopping once every task in the workplan is marked done.
|
||
|
|
|
||
|
|
## Core Idea
|
||
|
|
|
||
|
|
ralph-workplan exists to provide the capability described in INTENT.md.
|
||
|
|
|
||
|
|
## In Scope
|
||
|
|
|
||
|
|
- Defining the workplan Markdown file format (frontmatter + task blocks)
|
||
|
|
- Providing a Claude Code skill (`/ralph-workplan`) that starts a Ralph Loop bound to a workplan file
|
||
|
|
- Self-retiring the loop when all tasks reach `done` and workplan `status: done`
|
||
|
|
- Guarding against starting a loop on an already-completed workplan
|
||
|
|
- Install/uninstall tooling (`install.sh`) for the plugin
|
||
|
|
- Basic CI smoke workflow for the plugin
|
||
|
|
|
||
|
|
## Out of Scope
|
||
|
|
|
||
|
|
- Acting as a general-purpose task runner unrelated to workplan files
|
||
|
|
- External state coordination or persistence (no state hub, no HTTP calls)
|
||
|
|
- Implementing the underlying `/ralph-loop` plugin itself (this repo only builds on top of it)
|
||
|
|
- Task scheduling across multiple repos or domains
|
||
|
|
- Any sector-specific business logic (this is a dev-tooling repo, not a domain vertical)
|
||
|
|
|
||
|
|
## Current State
|
||
|
|
|
||
|
|
- Working prototype: skill and plugin scaffolding are in place with an install script, workplan spec, and a Forgejo CI smoke workflow; not yet published or widely adopted.
|
||
|
|
|
||
|
|
## Getting Oriented
|
||
|
|
|
||
|
|
- Start with: INTENT.md
|
||
|
|
- Agent instructions: AGENTS.md
|
||
|
|
- Workplans: workplans/
|