Skip to content

Docs visual improvements#15745

Merged
pzelasko merged 2 commits into
mainfrom
docs_visual_improvements
Jun 2, 2026
Merged

Docs visual improvements#15745
pzelasko merged 2 commits into
mainfrom
docs_visual_improvements

Conversation

@Ssofja
Copy link
Copy Markdown
Collaborator

@Ssofja Ssofja commented Jun 2, 2026

Important

The Update branch button must only be pressed in very rare occassions.
An outdated branch is never blocking the merge of a PR.
Please reach out to the automation team before pressing that button.

What does this PR do ?

Improves the docs top-level sidebar navigation by unwrapping nested sections so collections, tools, and APIs are visible without an extra click, reordering sidebar sections, and reordering collection entries.

Collection: Documentation (top-level docs navigation; affects all collections)

Changelog

  • docs/source/index.rst
    • Unwrapped Collections — list collection intro pages directly instead of a single "NeMo Collections" wrapper
    • Unwrapped Speech AI Tools — list individual tool pages directly instead of tools/intro
    • Unwrapped APIs — list core and collection API pages directly instead of apis
    • Moved Collections above APIs; moved APIs to the bottom of the sidebar
    • Collection order in sidebar: ASR → TTS → SpeechLM2 → Diarization → Speaker Recognition → Speech Enhancement (audio/intro) → SSL → Speech Classification
  • docs/source/collections.rst

Usage

N/A — documentation navigation change only. Preview locally:

pip install -r requirements/requirements_docs.txt
make -C docs html
open docs/build/html/index.html

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Docs-only change; no code or test changes required
  • Hub pages (collections.html, apis.html, tools/intro.html) remain in the repo for existing links but are no longer the primary sidebar entry points
  • dataloaders.rst and its placement in collections.rst are unchanged from Refactored all ASR collections documentation #15542

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Jun 2, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@Ssofja Ssofja requested a review from pzelasko June 2, 2026 18:11
@pzelasko pzelasko merged commit 8abf048 into main Jun 2, 2026
44 checks passed
@pzelasko pzelasko deleted the docs_visual_improvements branch June 2, 2026 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants