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: Add design section to readme #243

Merged
merged 8 commits into from
Oct 2, 2023
Merged

Conversation

MikeGoldsmith
Copy link
Contributor

Which problem is this PR solving?

Updates the repository readme to include a section about how the agent works along with a design image.

Short description of the changes

  • Add new agent_design.png
  • Update README to describe how the agent works

How to verify that this has the expected result

Repository readme includes more details on how the agent works.

@MikeGoldsmith MikeGoldsmith requested a review from a team September 26, 2023 14:51
@MikeGoldsmith MikeGoldsmith self-assigned this Sep 26, 2023
@MikeGoldsmith MikeGoldsmith added the type: documentation Improvements or additions to documentation label Sep 26, 2023
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jamie Danielson <[email protected]>
@JamieDanielson JamieDanielson merged commit d4df4ee into main Oct 2, 2023
@JamieDanielson JamieDanielson deleted the mike/production-docs branch October 2, 2023 20:03
@JamieDanielson JamieDanielson added the version: no bump A PR with maintenance or doc changes that aren't included in a release. label Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation version: no bump A PR with maintenance or doc changes that aren't included in a release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants