Docs cleanup: snake_case, state diagrams, slim README, .claude/ ignored#15
Merged
Conversation
Append mermaid stateDiagram-v2 diagrams for task and worker lifecycles to docs/design.md. Task diagram shows the API endpoints that drive each transition; worker diagram covers the simpler running/stopped model with an aside on lost-but-not-deleted workers. Add .claude/ to .gitignore — only ever holds per-developer state (settings.local.json, scheduled_tasks.lock). Remove the tracked lock file. NextUp additions: claude-code/codex task wrappers, MCP server wrapper, AI tool instructions for authoring task types, optional auto-start service registration in install scripts, and task scheduling (notBefore + cron). Updated the existing diagram entry to reflect that state machines are now done. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rename docs/ files to snake_case for consistency: Api.md → api.md, NextUp.md → next_up.md, TaskFlow.md → task_flow.md, TaskTypeDefinitions.md → task_type_definitions.md. Update Go test comments that referenced the old paths. Move task and worker state-machine diagrams from design.md to task_flow.md, where they live alongside the existing flow narrative and state definitions. Fix two endpoint typos in the diagrams I wrote earlier: PUT /task/:id/run not /start, PUT /worker/:id/stop not POST. Slim design.md back to origin/goals/architecture. Bring docs/api.md up to date with the actual routes in server/server.go: add /version, /config/, /ops/status/, log/tail endpoints. Add a sync reminder in CLAUDE.md so the doc doesn't drift the next time routes change. Aggressively trim the main README: keep tagline, install, 60-second start (with both curl and CLI submit to honor the RESTy promise), links into docs. Move detailed curl/CLI examples, file uploads, scripted submissions, and the task type schema deep-dive to a new docs/usage.md. Add docs/README.md as a landing index. Use relative links throughout the docs so local previews resolve. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
turtlemonvh
changed the title
Drop the "stub" disclaimer — the page now covers everything a user needs to author a task type. Replace the inaccurate "bash is the only executor" line with a table listing the four supported modes (bash, cmd, powershell, arbitrary -c executor) and a pointer to blanket task-validate. Add a windows_echo example so cmd usage is visible alongside bash. Add a Docker task type idea to next_up.md: either a first-class executor = "docker" with image/mounts fields, or a shipped bash example that wraps docker run. Lean toward example-first; promote if usage warrants. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Earlier in this branch (already in PR #15)
docs/task_flow.md).claude/ignored — only ever holds per-developer state. Removed the tracked lock fileNew in this push
Api.md→api.md,NextUp.md→next_up.md,TaskFlow.md→task_flow.md,TaskTypeDefinitions.md→task_type_definitions.md. Updated Go test comments that referenced the old paths.design.mdtotask_flow.mdwhere they sit next to the existing state definitions and flow narrative. Fixed two endpoint typos I had in the original diagrams (PUT /task/:id/runnot/start;PUT /worker/:id/stopnotPOST).server/server.go. Added/version,/config/,/ops/status/, log/tail endpoints. Added a sync reminder inCLAUDE.md.docs/usage.md.docs/README.mdindex so visitors land on a navigable page.Test plan
go build ./...cleango test ./server/ ./worker/passes (test comments updated)🤖 Generated with Claude Code