Skip to content

Commit eced96b

Browse files
Kasper Jungeclaude
authored andcommitted
docs: fix stale references to removed status command and inaccurate --force description
The cli.md docs claimed --force overwrites both ralph.toml and RALPH.md, but the code only overwrites ralph.toml (RALPH.md is always skipped if it exists). The codebase map and contributing guide still referenced the status command removed in v0.1.9, and the docs file listing was missing writing-prompts.md and api.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent e9e59a8 commit eced96b

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

β€Ždocs/cli.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ Initialize a project with `ralph.toml` and `RALPH.md`.
6666

6767
```bash
6868
ralph init
69-
ralph init --force # Overwrite existing files
69+
ralph init --force # Overwrite existing ralph.toml
7070
```
7171

7272
| Option | Short | Default | Description |
7373
|---|---|---|---|
74-
| `--force` | `-f` | off | Overwrite existing `ralph.toml` and `RALPH.md` |
74+
| `--force` | `-f` | off | Overwrite existing `ralph.toml` |
7575

7676
During init, ralphify detects your project type by looking for manifest files (`package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`). The detected type is displayed but doesn't currently change the generated configuration β€” all project types get the same defaults.
7777

β€Ždocs/contributing/codebase-map.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The core loop is simple. The complexity lives in **prompt assembly** β€” resolvi
1717
```
1818
src/ralphify/ # All source code
1919
β”œβ”€β”€ __init__.py # Version detection + app entry point
20-
β”œβ”€β”€ cli.py # CLI commands (init, run, status, new) β€” delegates to engine for the loop
20+
β”œβ”€β”€ cli.py # CLI commands (init, run, new) β€” delegates to engine for the loop
2121
β”œβ”€β”€ engine.py # Core run loop orchestration with structured event emission
2222
β”œβ”€β”€ manager.py # Multi-run orchestration (concurrent runs via threads)
2323
β”œβ”€β”€ checks.py # Discover and run validation checks, format failures

β€Ždocs/contributing/index.mdβ€Ž

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Tests use temporary directories and have no external dependencies β€” no API key
4444
tests/
4545
β”œβ”€β”€ conftest.py # Shared fixtures (disables streaming path for all tests)
4646
β”œβ”€β”€ test_checks.py # Check discovery and execution
47-
β”œβ”€β”€ test_cli.py # CLI commands (init, run, status, new)
47+
β”œβ”€β”€ test_cli.py # CLI commands (init, run, new)
4848
β”œβ”€β”€ test_contexts.py # Context discovery and injection
4949
β”œβ”€β”€ test_detector.py # Project type detection
5050
β”œβ”€β”€ test_discovery.py # Primitive directory scanning
@@ -85,10 +85,12 @@ The `--strict` flag treats warnings as errors. The CI pipeline uses this flag, s
8585
docs/
8686
β”œβ”€β”€ index.md # Landing page
8787
β”œβ”€β”€ getting-started.md # Step-by-step tutorial
88+
β”œβ”€β”€ writing-prompts.md # Patterns for effective autonomous loop prompts
8889
β”œβ”€β”€ agents.md # Setup guides for different agents
8990
β”œβ”€β”€ cookbook.md # Complete copy-pasteable setups
9091
β”œβ”€β”€ primitives.md # Checks, contexts, ralphs reference
9192
β”œβ”€β”€ cli.md # Configuration and CLI reference
93+
β”œβ”€β”€ api.md # Python library reference (run_loop, RunConfig, events)
9294
β”œβ”€β”€ troubleshooting.md # Troubleshooting and FAQ
9395
β”œβ”€β”€ contributing/ # Contributor docs (this section)
9496
β”‚ β”œβ”€β”€ index.md # This page

0 commit comments

Comments
Β (0)