Conversation
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
Signed-off-by: jgerh <jgerhold@nvidia.com>
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughAdds extensive docs infrastructure (Sphinx config, Makefile, custom extensions for AI Assistant, enhanced search, JSON output, content gating), major documentation reorganization/additions/removals, Dockerfiles (new multi-stage builds, vLLM build, hermetic/release flows), repo/config updates (.gitignore, .dockerignore, codecov, pre-commit, CodeRabbit), and submodule/workspace adjustments (Megatron Bridge added; NeMo packaging removed). Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant U as User (Docs site)
participant ES as EnhancedSearch (JS)
participant SE as SearchEngine (Lunr)
participant DL as DocumentLoader
participant AI as AI Assistant
Note over ES: On DOMContentLoaded
ES->>DL: loadDocuments()
DL-->>ES: documents[]
ES->>SE: initialize(documents)
U->>ES: type query
ES->>SE: search(query, filters)
SE-->>ES: results
ES->>AI: analyzeQuery(query, results) [optional, threshold-based]
AI-->>ES: aiResponse or error
ES-->>U: render results (+ AI panel if available)
sequenceDiagram
autonumber
participant S as Sphinx
participant JO as JSONOutputBuilder
participant DD as DocumentDiscovery
participant JF as JSONFormatter
participant JW as JSONWriter
participant HC as JSONOutputCache
S->>JO: on_build_finished()
JO->>DD: get_all_documents_recursive()
DD-->>JO: docnames[]
loop per document
JO->>HC: needs_update(doc)
alt needs update
JO->>JF: build_json_data(doc)
JF-->>JO: json data
JO->>JW: write_json_file(doc, data)
JW-->>JO: OK
JO->>HC: mark_updated(doc)
else
JO-->>S: skip doc
end
end
JO-->>S: done
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120+ minutes Possibly related PRs
Suggested reviewers
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro ⛔ Files ignored due to path filters (5)
📒 Files selected for processing (107)
⛔ Files not processed due to max files limit (16)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Closing for re-evaluation |
What does this PR do ?
This is a comprehensive end-to-end review of the NeMo RL documentation refactor project. We’re sharing the full branch so you can view the final state of the documentation, with all links intact, and preview the content as needed.
Important: These doc drafts are AI-assisted and use the source code and existing documentation to curate the new content. If you see something odd, chances are it is incorrect. Be sure to flag any issues you find in your review comments.
Review Content
Please assess the documentation’s overall structure and organization for clarity and usability, and review each file thoroughly to ensure accuracy and completeness.
Preview Docs
make docs-env.make docs-live.Summary by CodeRabbit
New Features
Documentation
Chores