Skip to content

docs: streamline README getting started#171

Merged
edwin-zvs merged 1 commit into
mainfrom
readme-followup-getting-started
May 23, 2026
Merged

docs: streamline README getting started#171
edwin-zvs merged 1 commit into
mainfrom
readme-followup-getting-started

Conversation

@edwin-zvs

Copy link
Copy Markdown
Contributor

Summary

  • Remove Persistent sessions and Native PTY mode bullets from the README Why agentd section
  • Make Getting started install-first and move source builds to a separate Building from source section after Upgrading
  • Rename step 4 to Start your agent and use installed binary commands

Testing

  • cargo build --workspace
  • git diff --check

No screenshot/video: documentation-only change.

Comment thread README.md Outdated

```sh
./target/debug/agentd run
agentd run

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

is it just agentd run or agentd?

Comment thread README.md
work without leaving the flow.

### 4. Try the built-in Zarvis agent
### 4. Start your agent

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

"Happy hacking"

Comment thread README.md Outdated

./target/debug/agent new zarvis "list the Rust crates and explain what each one does"
agent new zarvis "list the Rust crates and explain what each one does"
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Let's remove all of this and just say something user can do, such as "Hacking into your dream idea from your terminal, ask Codex, Clade code, Antigravity and Zarvis dive into hard challenge from your mobile"

Link 'Zarvis' to its own doc

@edwin-zvs

Copy link
Copy Markdown
Contributor Author

Addressed review feedback in the latest commit:

  • Changed daemon startup command from agentd run to agentd (the default subcommand already runs the daemon).
  • Replaced the step 4 Zarvis setup block with a short “Happy hacking” paragraph focused on what the user can do.
  • Linked Zarvis to docs/zarvis.md.

Validation:

  • cargo build --workspace
  • git diff --check

@edwin-zvs
edwin-zvs force-pushed the readme-followup-getting-started branch from c0c22a9 to 6438db6 Compare May 23, 2026 15:48
@edwin-zvs
edwin-zvs merged commit 40bca9a into main May 23, 2026
1 check passed
@edwin-zvs
edwin-zvs deleted the readme-followup-getting-started branch May 23, 2026 16:00
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.

1 participant