chore(docs): remove pre-Fern assets - #6654
Merged
Merged
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
📝 WalkthroughWalkthroughThe PR removes legacy JSON-output and enhanced-search documentation tooling, updates Fern and contributor guidance, removes the uv-managed Python setup path, and adjusts linting and documentation contract checks for the new documentation layout. ChangesDocumentation and setup cleanup
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-6654.docs.buildwithfern.com/nemoclaw |
Contributor
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage remains at 96%, unchanged from the TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most impacted files.
Updated |
Contributor
E2E Advisor RecommendationRequired E2E: Dispatch hint: Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
Dispatch hint
|
Contributor
E2E Target RecommendationRequired E2E targets: Dispatch required E2E targets:
Full E2E target advisor summaryE2E Target AdvisorBase: Required E2E targets
Optional E2E targets
Relevant changed files
|
Contributor
PR Review Advisor (Nemotron Ultra) — InformationalMerge posture: Informational / low confidence Action checklist
Findings index
Review findings by urgency: 0 required fixes, 1 item to resolve/justify, 0 in-scope improvements
|
Contributor
PR Review Advisor — Changes requestedMerge posture: Do not merge yet Action checklist
Findings index
Review findings by urgency: 0 required fixes, 1 item to resolve/justify, 0 in-scope improvements
|
miyoungc
marked this pull request as ready for review
July 10, 2026 20:43
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
scripts/dev-setup.sh (1)
277-294: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winDiscover all supported Python 3.x binaries.
find_local_pythononly probespython3andpython3.11throughpython3.14. If a machine exposes only a newer versioned executable onPATH, setup and doctor incorrectly report that Python 3.11+ is unavailable. Enumeratepython3.*candidates dynamically and add a regression fixture for a newer versioned interpreter.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/dev-setup.sh` around lines 277 - 294, Update find_local_python to dynamically discover all python3.* executables available on PATH, while retaining the unversioned python3 candidate and validating each discovered interpreter with the existing version checks. Ensure candidates are deduplicated and safely handled, then add a regression fixture covering a newer versioned interpreter that is at least Python 3.11.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Line 156: Update the external-link guidance in AGENTS.md to match the broader
exception already permitted in CONTRIBUTING.md, including official dependency
documentation and industry standards; alternatively, explicitly state that
Node.js and Python are examples rather than an exhaustive allowlist. Keep both
documents consistent.
---
Outside diff comments:
In `@scripts/dev-setup.sh`:
- Around line 277-294: Update find_local_python to dynamically discover all
python3.* executables available on PATH, while retaining the unversioned python3
candidate and validating each discovered interpreter with the existing version
checks. Ensure candidates are deduplicated and safely handled, then add a
regression fixture covering a newer versioned interpreter that is at least
Python 3.11.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f205760c-09bb-4216-aab0-f77b4b0b9017
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (41)
.pre-commit-config.yamlAGENTS.mdCONTRIBUTING.mdbiome.jsondocs/CONTRIBUTING.mddocs/_ext/json_output/__init__.pydocs/_ext/json_output/config.pydocs/_ext/json_output/content/__init__.pydocs/_ext/json_output/content/extractor.pydocs/_ext/json_output/content/metadata.pydocs/_ext/json_output/content/structured.pydocs/_ext/json_output/content/text.pydocs/_ext/json_output/core/__init__.pydocs/_ext/json_output/core/builder.pydocs/_ext/json_output/core/document_discovery.pydocs/_ext/json_output/core/global_metadata.pydocs/_ext/json_output/core/hierarchy_builder.pydocs/_ext/json_output/core/json_formatter.pydocs/_ext/json_output/core/json_writer.pydocs/_ext/json_output/processing/__init__.pydocs/_ext/json_output/processing/cache.pydocs/_ext/json_output/processing/processor.pydocs/_ext/json_output/utils.pydocs/_ext/search_assets/__init__.pydocs/_ext/search_assets/enhanced-search.cssdocs/_ext/search_assets/main.jsdocs/_ext/search_assets/modules/DocumentLoader.jsdocs/_ext/search_assets/modules/EventHandler.jsdocs/_ext/search_assets/modules/ResultRenderer.jsdocs/_ext/search_assets/modules/SearchEngine.jsdocs/_ext/search_assets/modules/SearchInterface.jsdocs/_ext/search_assets/modules/SearchPageManager.jsdocs/_ext/search_assets/modules/Utils.jsdocs/_ext/search_assets/templates/search.htmldocs/_templates/layout.htmlfern/docs.ymlpyproject.tomlscripts/dev-setup.shtest/dev-setup-doctor.test.tstest/e2e/e2e-cloud-experimental/check-docs.shtest/pr-workflow-contract.test.ts
💤 Files with no reviewable changes (31)
- pyproject.toml
- docs/_ext/search_assets/templates/search.html
- docs/_ext/json_output/init.py
- docs/_ext/search_assets/modules/SearchPageManager.js
- docs/_templates/layout.html
- docs/_ext/json_output/core/init.py
- docs/_ext/search_assets/modules/DocumentLoader.js
- docs/_ext/json_output/config.py
- docs/_ext/json_output/core/builder.py
- docs/_ext/json_output/content/init.py
- docs/_ext/json_output/core/json_writer.py
- docs/_ext/json_output/core/hierarchy_builder.py
- docs/_ext/search_assets/modules/ResultRenderer.js
- docs/_ext/json_output/content/metadata.py
- docs/_ext/json_output/content/structured.py
- docs/_ext/search_assets/main.js
- docs/_ext/json_output/core/document_discovery.py
- docs/_ext/json_output/content/text.py
- docs/_ext/json_output/utils.py
- docs/_ext/search_assets/modules/Utils.js
- docs/_ext/search_assets/modules/SearchEngine.js
- docs/_ext/json_output/processing/init.py
- docs/_ext/search_assets/modules/SearchInterface.js
- docs/_ext/search_assets/modules/EventHandler.js
- docs/_ext/json_output/processing/cache.py
- docs/_ext/json_output/core/global_metadata.py
- docs/_ext/search_assets/enhanced-search.css
- docs/_ext/json_output/core/json_formatter.py
- docs/_ext/search_assets/init.py
- docs/_ext/json_output/content/extractor.py
- docs/_ext/json_output/processing/processor.py
| ### No External Project Links | ||
|
|
||
| Do not add links to third-party code repositories, community collections, or unofficial resources. Links to official tool documentation (Node.js, Python, uv) are acceptable. | ||
| Do not add links to third-party code repositories, community collections, or unofficial resources. Links to official tool documentation (Node.js and Python) are acceptable. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the external-link exception.
CONTRIBUTING.md Line 351 also permits official documentation for dependencies and industry standards, so this narrower Node.js/Python wording may give agents and contributors contradictory guidance. Use the same allowlist in both files, or make the examples explicitly non-exhaustive.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` at line 156, Update the external-link guidance in AGENTS.md to
match the broader exception already permitted in CONTRIBUTING.md, including
official dependency documentation and industry standards; alternatively,
explicitly state that Node.js and Python are examples rather than an exhaustive
allowlist. Keep both documents consistent.
Source: Coding guidelines
cv
approved these changes
Jul 10, 2026
Hadar301
pushed a commit
to Hadar301/NemoClaw-OpenShift
that referenced
this pull request
Jul 12, 2026
<!-- markdownlint-disable MD041 --> ## Summary Remove the retired Sphinx documentation assets and dependency environment left behind after the Fern migration. Keep contributor setup aligned with the current Fern toolchain by validating Python directly without creating an unused `uv` environment. ## Changes - Remove the legacy Sphinx JSON/search extensions and layout template under `docs/_ext/` and `docs/_templates/`. - Remove the Sphinx-only `pyproject.toml` and `uv.lock`, plus their Biome and hook wiring. - Update contributor setup, tests, and guidance to require Python 3.11+ directly while preserving the Fern-era platform docs generator. - Remove remaining Sphinx/MyST migration wording and compatibility handling from Fern documentation checks. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [x] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates <!-- Check exactly one tests line and one docs line. Check other lines when applicable. Add every requested justification or approval reference. --> - [x] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [ ] Tests not applicable — justification: - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification <!-- Check each applicable item only when supported by the requested evidence. Run targeted tests once per relevant change set and rerun after later edits or hook autofixes that can affect the tested behavior. Do not rerun hook-covered checks. --> - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run check:diff` passed when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above — `test/dev-setup-doctor.test.ts` (38 passed), focused `test/pr-workflow-contract.test.ts` assertion (passed), and `check-docs.sh --only-cli` (passed) - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — deferred to draft PR CI - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) — passed with 0 errors and one Fern upgrade warning - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Removed Features** - Removed enhanced documentation search, including advanced filtering, highlighting, and AI-assisted search integration. - Removed automatic JSON documentation output generation and related search-index data exports. - Removed the legacy analytics script integration from documentation pages. - **Documentation** - Updated contributor setup instructions to use locally installed Python 3.11 or newer. - Refreshed documentation guidance for Fern MDX pages and official tool documentation links. - **Developer Experience** - Simplified repository setup by removing the requirement for `uv`. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Miyoung Choi <miyoungc@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
2 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.
Summary
Remove the retired Sphinx documentation assets and dependency environment left behind after the Fern migration.
Keep contributor setup aligned with the current Fern toolchain by validating Python directly without creating an unused
uvenvironment.Changes
docs/_ext/anddocs/_templates/.pyproject.tomlanduv.lock, plus their Biome and hook wiring.Type of Change
Quality Gates
Verification
Verifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailabletest/dev-setup-doctor.test.ts(38 passed), focusedtest/pr-workflow-contract.test.tsassertion (passed), andcheck-docs.sh --only-cli(passed)npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — deferred to draft PR CInpm run docsbuilds without warnings (doc changes only) — passed with 0 errors and one Fern upgrade warningSigned-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Removed Features
Documentation
Developer Experience
uv.