Skip to content

docs: task-based user guides for install and /do-work - #3

Merged
rawphp merged 2 commits into
rawphp:mainfrom
henry-bonvi:docs/user-facing-guide
Jul 26, 2026
Merged

docs: task-based user guides for install and /do-work#3
rawphp merged 2 commits into
rawphp:mainfrom
henry-bonvi:docs/user-facing-guide

Conversation

@henry-bonvi

Copy link
Copy Markdown
Contributor

Summary

  • Add user-facing docs under docs/: getting started, concepts, commands reference, troubleshooting, and a docs index.
  • Light README link section so operators find the guides from the repo root.
  • Point docs/HOW-IT-WORKS.md at the happy-path guide; keep it as the deep dive.

Why

End users installing and running /do-work needed task-based pages (one job per page) instead of only README + design walkthrough.

Test plan

  • Open each new doc from docs/README.md and confirm internal links resolve
  • Skim command table against SKILL.md / agents/*.md quick reference
  • Confirm install notes mention rawphp/do-work and DO_WORK_REPO_URL override (install.sh still defaults to agent-native)
  • No runtime/skill code changes in this PR

henry-bonviand others added 2 commits July 25, 2026 11:56
Add getting-started, concepts, commands, troubleshooting, and a docs
index so operators can run start/go without reading eng design notes.
Link the set from README and point HOW-IT-WORKS at the happy path.
Review feedback: install is hub-based and not limited to Claude Code/Codex.
@rawphp

Copy link
Copy Markdown
Owner

Addressed the harness framing feedback on README L3 in 95b9bb8:

  • README lead + badge strip: any agent harness (Claude/Codex as examples only)
  • docs/README.md, docs/getting-started.md, docs/HOW-IT-WORKS.md aligned the same way

Happy to tweak further if you want Cursor/others called out differently or the example badges dropped entirely.

@rawphp
rawphp merged commit 4be78a2 into rawphp:mainJul 26, 2026
1 check passed
Sign up for freeto 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.

2 participants

@henry-bonvi@rawphp