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

Write a getting started document for users to navigate through the UI #249

Open
vishnoianil opened this issue Oct 7, 2024 · 5 comments
Open
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@vishnoianil
Copy link
Member

The guide should provide the higher level details about the supported feature and how user can consume these feature.

@vishnoianil vishnoianil added bug Something isn't working documentation Improvements or additions to documentation labels Oct 7, 2024
@vishnoianil vishnoianil added this to UI Oct 7, 2024
@vishnoianil vishnoianil moved this to Ready in UI Oct 7, 2024
@vishnoianil vishnoianil added this to the release-1.1 milestone Oct 7, 2024
@vishnoianil vishnoianil added the good first issue Good for newcomers label Oct 7, 2024
@vishnoianil
Copy link
Member Author

cc: @Misjohns FYI

@dominikkawka
Copy link
Member

instructlab/docs.instructlab.ai#7

I've written a document that gives a general overview of the playground + contributions, along with setting the UI up locally, including .env settings and OAuth. Feedback would be appreciated :D

@vishnoianil
Copy link
Member Author

cc: @nerdalert @aevo98765 @Misjohns please take a look at the PR @dominikkawka pushed. Love to get that merged as soon as possible. This is awesome work @dominikkawka . Appreciate nailing that down.

@mingxzhao
Copy link
Member

FYI

https://github.com/IBM/opensource-ai-workshop/tree/main/docs/lab-5

Fairly detailed walkthrough of submission process through UI, could be worth integrating into UI docs? just not sure where it would fit.

@vishnoianil
Copy link
Member Author

FYI

https://github.com/IBM/opensource-ai-workshop/tree/main/docs/lab-5

Fairly detailed walkthrough of submission process through UI, could be worth integrating into UI docs? just not sure where it would fit.

This is awesome @mingxzhao. @dominikkawka looks like we can merge this document in your PR. wdyt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Ready
Development

No branches or pull requests

5 participants