Conversation
jwilber
requested review from
dorotat-nv,
jstjohn,
malcolmgreaves,
pstjohn and
trvachov
as code owners
Signed-off-by: Jared Wilber <jwilber@nvidia.com>
Signed-off-by: Jared Wilber <jwilber@nvidia.com>
Signed-off-by: Jared Wilber <jwilber@nvidia.com>
jwilber
force-pushed
the
jwilber/docs-chatbot
branch
from
9317eb1 to
fc34627
Compare
Signed-off-by: Jared Wilber <jwilber@nvidia.com>
Collaborator
Author
|
/ok to test 298a98b |
@jwilber, there was an error processing your request: See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/ |
tshimko-nv
approved these changes
May 28, 2025
Collaborator
Author
|
/ok to test b1911a2 |
camirr-nv
pushed a commit
that referenced
this pull request
Jun 26, 2025
### Description Adds a chatbot UI to our documentation:  In particular, I've injected the compiled static assets for the production build of the [NVES chat bot app](https://gitlab-master.nvidia.com/nves/llm_bot/-/tree/main/chat_frontend) into our `mkdocs` page. (The BioNeMo 2 docs are being indexed for this chatbot). Because of the different rendering strategies used between react and mkdocs, we need to turn off the `navigation.instant` and `navigation.instant.prefetch` features of mkdocs to allow for the chat to work on navigation. Note - because we don't have a great system for testing changes in live docs, I've made the default behavior for the chatbot invisible/unclickable, so we can turn it on with dev tools and investigate in 'secret' 🥷. ### Type of changes <!-- Mark the relevant option with an [x] --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Refactor - [x] Documentation update - [ ] Other (please describe): > [!NOTE] > By default, the notebooks validation tests are skipped unless explicitly enabled. ### Usage Checkout this branch, and in the root of the repo, build the docs ``` docker build -t nvcr.io/nvidian/cvai_bnmo_trng/bionemo2-docs -f docs/Dockerfile . ``` then run the docs: ``` docker run --rm -it -p 8000:8000 \ -v ${PWD}/docs:/docs -v ${PWD}/sub-packages:/sub-packages \ nvcr.io/nvidian/cvai_bnmo_trng/bionemo2-docs:latest ``` --------- Signed-off-by: Jared Wilber <jwilber@nvidia.com> Signed-off-by: Ubuntu <camirr@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a chatbot UI to our documentation:
In particular, I've injected the compiled static assets for the production build of the NVES chat bot app into our
mkdocspage. (The BioNeMo 2 docs are being indexed for this chatbot).Because of the different rendering strategies used between react and mkdocs, we need to turn off the
navigation.instantandnavigation.instant.prefetchfeatures of mkdocs to allow for the chat to work on navigation.Note - because we don't have a great system for testing changes in live docs, I've made the default behavior for the chatbot invisible/unclickable, so we can turn it on with dev tools and investigate in 'secret' 🥷.
Type of changes
Note
By default, the notebooks validation tests are skipped unless explicitly enabled.
Usage
Checkout this branch, and in the root of the repo, build the docs
then run the docs: