Skip to content

Fix #56: Clean up the readme#57

Merged
max-tet merged 2 commits intomainfrom
clayde/issue-56-update-readme
Mar 26, 2026
Merged

Fix #56: Clean up the readme#57
max-tet merged 2 commits intomainfrom
clayde/issue-56-update-readme

Conversation

@ClaydeCode
Copy link
Copy Markdown
Owner

Closes #56

Updated README.md: replaced outdated 4-state flow with full Mermaid state diagram covering all 10 states (preliminary_planning through done/failed/interrupted), rewrote Safety Gates section to describe content filtering approach, merged the overlapping Setup and Deploying sections into a single unified Setup section, fixed CLAYDE_LOOP_INTERVAL_S → CLAYDE_INTERVAL, added CLAYDE_INTERVAL to the configuration table, and updated What is Clayde to describe the two-phase planning flow.

…ions, and Mermaid diagram

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ClaydeCode ClaydeCode mentioned this pull request Mar 26, 2026
@ClaydeCode ClaydeCode requested a review from max-tet March 26, 2026 11:08

Each issue moves through the following states:

```
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diagram misses some edges:

  • for both planning phases, additional comments trigger plan changes.
  • Small issues skip the thorogh plan. This is also never mentioned in the text but should be.

…small issues

- Add self-loop edges on awaiting_preliminary_approval and awaiting_plan_approval
  showing that new comments trigger a plan update
- Add edge showing small issues skip thorough planning and go straight to
  implementing on preliminary approval
- Update state table descriptions to reflect plan-update and small-issue behavior
- Update the "What is Clayde?" step list to mention the small issue shortcut
  and plan update behavior

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@max-tet max-tet merged commit e05e10d into main Mar 26, 2026
2 checks passed
@max-tet max-tet deleted the clayde/issue-56-update-readme branch March 26, 2026 11:29
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.

Clean up the readme

2 participants