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

Add missing assistant UI documentation steps #935

Conversation

dragosMC91
Copy link
Collaborator

@dragosMC91 dragosMC91 commented Dec 10, 2023

Why are these changes needed?

The documentation for building the autogen assitant ui libary locally seems to be incomplete -> see https://github.com/microsoft/autogen/tree/main/samples/apps/autogen-assistant#installation, Install from Source section
The current steps mention building the frontend, then running the application via the autogenra ui command.

However, when following these steps, the user will the the error pyenv: autogenra: command not found which is expected since he did not build the python library.

This PR adds the missing build/install local autogenra library step in the docs.

Additional changes: minor markdown enhancements to docs

autogensamplesappsautogen-assistant at main · microsoftautogen 2023-12-10 at 6 07 06 PM

Checks

@codecov-commenter
Copy link

codecov-commenter commented Dec 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (083f522) 26.63% compared to head (b8f6d30) 26.63%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #935   +/-   ##
=======================================
  Coverage   26.63%   26.63%           
=======================================
  Files          28       28           
  Lines        3777     3777           
  Branches      858      858           
=======================================
  Hits         1006     1006           
  Misses       2700     2700           
  Partials       71       71           
Flag Coverage Δ
unittests 26.58% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@victordibia victordibia left a comment

Choose a reason for hiding this comment

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

Thanks

@dragosMC91
Copy link
Collaborator Author

Thanks

@victordibia thanks for the approve, I cannot merge the PR though, could you merge it?

@qingyun-wu qingyun-wu added this pull request to the merge queue Dec 18, 2023
Merged via the queue into microsoft:main with commit 056bf01 Dec 18, 2023
16 checks passed
rlam3 pushed a commit to rlam3/autogen that referenced this pull request Dec 19, 2023
* Add missing assistant UI documentation steps

* Format documentation page for consistency

* Add missing step for installing the autogenra library
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* Add missing assistant UI documentation steps

* Format documentation page for consistency

* Add missing step for installing the autogenra library
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.

None yet

4 participants