Skip to content

docs: rewrite README for operators discovering the project#67

Merged
pentaxis93 merged 3 commits intomainfrom
issue-42/write-a-readme-that-makes-people-want-to-use
Apr 10, 2026
Merged

docs: rewrite README for operators discovering the project#67
pentaxis93 merged 3 commits intomainfrom
issue-42/write-a-readme-that-makes-people-want-to-use

Conversation

@pentaxis93
Copy link
Copy Markdown
Owner

@pentaxis93 pentaxis93 commented Apr 10, 2026

Summary

  • Replaces the reference-stub README with an operator-facing entry point that answers what/why/how/deeper within seconds.
  • Features the full annotated examples/agentd.toml config and a three-beat session walkthrough (start daemon, trigger session, what the agent sees inside the container).
  • Contextualized links to ARCHITECTURE.md, AGENTS.md, and the example config.

Resolves #42

Test plan

  • Read the first two sections (title + Why) and confirm a newcomer could explain what agentd does and why.
  • Verify the embedded config block matches examples/agentd.toml exactly.
  • Verify all links resolve: ARCHITECTURE.md, AGENTS.md, examples/agentd.toml, LICENSE.
  • Confirm status claims match actual codebase state.
  • Render on GitHub and check for formatting issues.
  • git diff main shows only README.md changed — no behavioral code changes.

@pentaxis93
docs: rewrite README for operators discovering the project
8272ccc 
The previous README was a reference stub — status bullets, operational
minutiae, and an architecture summary that served someone already
oriented. The new README answers four questions fast: what agentd is,
why it exists, how to try it, and where to go deeper.

Resolves #42
@pentaxis93
style: apply rustfmt to workspace
40099c6
@pentaxis93
docs: restore operator-relevant details to README
a8cbd30 
Add bare-invocation equivalence, two-signal shutdown behavior, and
agentd-run config resolution. Remove forward reference to nonexistent
scheduler crate name.
@pentaxis93 pentaxis93 merged commit 764427c into main Apr 10, 2026
2 checks passed
@pentaxis93 pentaxis93 deleted the issue-42/write-a-readme-that-makes-people-want-to-use branch April 10, 2026 00:57
@pentaxis93 pentaxis93 mentioned this pull request Apr 10, 2026
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Write a README that makes people want to use agentd

1 participant

@pentaxis93