docs: surface args so users can parameterize ralph loops#53
Merged
Conversation
Highlight the args frontmatter field across the README and docs entry points, and reframe a ralph as a directory conforming to the open ralph loops format (ralphloops.io) rather than a lone RALPH.md file. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
ralphify-co | 196f4e3 | Commit Preview URL Branch Preview URL |
Jun 08 2026, 05:09 PM |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
argsfrontmatter field where newcomers first form their mental model — the README's "Write a ralph" job, the docs index hero/card, and the getting-started manual setup. Reference pages already coveredargs; the gap was in the entry-point surfaces.agent+commands+argstogether with aralph run my-ralph --focus src/authinvocation (a format illustration, not a worked example, per request).RALPH.md, conforming to the open ralph loops format, rather than a lone file.docs/diary/.Docs-only change.
Test plan
uv run mkdocs build --strict— passes (the red mkdocs-material marketing banner on stderr is unrelated).uv run pytest -q— 627 passed, 1 xpassed.🤖 Generated with Claude Code