Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: simplify README.md, split instructions in separate docs/* md files. #66

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cyborgmarina
Copy link
Contributor

No description provided.

Comment on lines +24 to +27
```bash
pipx install devon_agent
npm install -g devon-tui
```

Choose a reason for hiding this comment

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

What do you think about add a section with instructions about how to update the packages?

pipx upgrade devon_agent
npm i -u -g devon-tui

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good idea!

@ObjectJosh
Copy link
Contributor

Hey @cyborgmarina! Much more organized, thank you! I just wanted to comment on the "feel" of it though, since I have the two open side-by-side and the longer one feels more right, I think because it has more content - thus making it more "interesting" to look at. I do think there should be a balance, though. Need to keep in mind that nesting content causes an extra step in clicking (vs scrolling). Also could play around and maybe see how others use table of contents effectively 🤔

@cyborgmarina
Copy link
Contributor Author

Hey @ObjectJosh ! Thanks for the feedback.
Yes, makes sense, I will move to a table of contents and see how it looks like.

@akiradev0x
Copy link
Contributor

Goat, we now have the ui too!

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.

4 participants