mirror of
https://github.com/NVIDIA/Model-Optimizer.git
synced 2026-10-02 03:14:52 +08:00
Chenhan D. Yu
ddca53b4bf
## Summary - Add a JS/static announcements landing page for GitHub Pages - Keep existing Sphinx docs available under the `api/` subpath - Add PR-authored announcement posts with tags, search/filtering, image support, and a DSpark vs Domino sample post Jira: https://jirasw.nvidia.com/browse/OMNIML-5476 ## Verification - `python3 docs/build_site.py --output docs/build/html` - Local preview checked at `http://127.0.0.1:8088/` ## Publishing approval User explicitly approved publishing the `dspark-vs-domino` sample post and copied image assets from `modelopt-site` to public GitHub in `NVIDIA/Model-Optimizer`. ## Notes - Full `uv run nox -s docs` was attempted locally, but dependency setup/download did not complete in a reasonable time; CI should provide the authoritative full docs build and PR Pages preview. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added an interactive announcements hub to the documentation homepage with date sorting, tag filtering, search, pagination, and empty-state messaging. * Improved announcement presentation with consistent cards, metadata, typography, and interactive controls. * **Documentation** * Added announcements covering the GitHub Pages announcement hub and a DSpark versus Domino comparison. * Added guidance for authoring, reviewing, and discovering future announcements. * Updated documentation navigation to feature announcements while keeping other sections accessible. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Chenhan Yu <chenhany@nvidia.com>
24 lines
1.1 KiB
ReStructuredText
24 lines
1.1 KiB
ReStructuredText
:orphan:
|
|
|
|
Model Optimizer Announcements Are Moving to GitHub Pages
|
|
#########################################################
|
|
|
|
:Author: Model Optimizer Team
|
|
:Date: August 13, 2026
|
|
:Tags: release, docs, github-pages
|
|
|
|
The Model Optimizer GitHub Pages site is expanding from API documentation into a lightweight announcement hub. The goal is to make releases, technical notes, examples, and deployment writeups easier to discover without introducing a separate publishing system.
|
|
|
|
What Changes
|
|
************
|
|
|
|
* Announcements live in the documentation source and are reviewed through pull requests.
|
|
* The landing page defaults to announcements.
|
|
* Existing API documentation remains available from the Sphinx left navigation.
|
|
* Announcement pages support tags, search, filtering, and embedded images.
|
|
|
|
Authoring Flow
|
|
**************
|
|
|
|
Add a Sphinx page under ``docs/source/announcements/``, add its ``.announcement-card`` metadata and link to ``docs/source/index.rst``, and link it from the announcements toctree when applicable. The GitHub Pages workflow rebuilds the static site from committed source, so every announcement follows the same review path as code and docs.
|