h2o-llmstudio
h2o-llmstudio copied to clipboard
Published
20 hours ago •
h2oai
h2oai
Push official docs site for LLM Studio
This PR documents official docs for LLM Studio using Makersaurus (the documentation platform used to document H2O products). The content is sourced from various sources including, but not limited to - demo videos, the repo readme, tooltips, various blogs, slack channels, and zoom meeting recordings.
Resolves: https://github.com/h2oai/h2o-llmstudio/issues/89
Note: If you see anything that does not appear nicely formatted on Github such as content "tabs", please note that it does appear in a presentable format when the docs site is deployed.
Pending action items:
- [ ] Get docs reviewed
- [x] Check and fix all internal links and remove unnecessary commented lines
- [x] Import tooltip.mdx files to docs in a cleaner way
- [x] Check if release notes are required
- [ ] Add an end-to-end happy path tutorial
Response to review comments:
Thank you for the review!
- The makersaurus source code and repo is not public. Only the compiled Makersaurus npm package is public. I will dig some more into this and try to do some testing with a non-h2o account.
- Done. Changes from
mainhave been merged to this branch. - I will request for a version of the logo for dark theme (is it alright if this is changed in another PR?)
- These vulnerabilities are from Docusaurus dependencies (e.g., see this unresolved issue) and I think it will be difficult to avoid them since our docs platform is built on top of Docusaurus.
- Ack. Shall we document these feature guides in a separate new PR please?
- Done
- Done
- I added a
deploy-to-github-pagesscript. When we run the workflow, it will deploy docs to GH pages. Right now, I think we should leave the workflow to be triggered manually instead of upon each PR merge so that we can choose to send shorter, cleaner PRs for separate things and then push all the changes to deployment in one go (like a release). WDYT?
CC: @pascal-pfeiffer @psinger
