Skip to content

docs: Update docs version for 0.3.0#211

Merged
chtruong814 merged 2 commits into
NVIDIA-NeMo:mainfrom
chtruong814:chtruong/update-0.3.0-docs
May 29, 2026
Merged

docs: Update docs version for 0.3.0#211
chtruong814 merged 2 commits into
NVIDIA-NeMo:mainfrom
chtruong814:chtruong/update-0.3.0-docs

Conversation

@chtruong814

@chtruong814 chtruong814 commented May 29, 2026

Copy link
Copy Markdown
Contributor

docs: Update docs version for 0.3.0

Add release docs workflow for manual publishing

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
@greptile-apps

greptile-apps Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR prepares the documentation infrastructure for the 0.3.0 release by updating version metadata and adding a new GitHub Actions workflow for publishing docs to Akamai/S3.

  • docs/project.json: Bumps the tracked docs version from 0.1.0 to 0.3.0.
  • docs/versions1.json: Adds 0.3.0 (marked preferred) and 0.2.0 to the version picker, and converts the existing 0.1.0 entry from a relative URL to an absolute docs.nvidia.com URL.
  • .github/workflows/release-docs.yml: Introduces a new workflow_dispatch / workflow_call workflow that builds docs via FW-CI-templates@v0.67.0 and publishes them via the publish-docs action at v0.74.0, with dry-run support and optional email notifications.

Confidence Score: 5/5

Safe to merge — all three changes are straightforward docs versioning updates with no logic or runtime risk.

The changes are limited to bumping a version string in project.json, extending the version-picker JSON with correct absolute URLs, and adding a well-structured CI workflow that delegates all heavy lifting to pinned, shared FW-CI-templates actions. No application logic is touched.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/release-docs.yml New reusable/manual workflow for building and publishing versioned docs to Akamai/S3; uses pinned FW-CI-templates refs and standard NVIDIA secrets/vars.
docs/project.json Version bumped from 0.1.0 to 0.3.0 to match the release.
docs/versions1.json Added 0.3.0 (latest) and 0.2.0 entries; updated 0.1.0 URL from relative to absolute; preferred flag moved to 0.3.0.

Sequence Diagram

sequenceDiagram
    participant Trigger as workflow_dispatch / workflow_call
    participant BuildJob as build-docs job (FW-CI-templates@v0.67.0)
    participant PublishJob as publish-docs job (FW-CI-templates@v0.74.0)
    participant Akamai as Akamai CDN
    participant S3 as AWS S3

    Trigger->>BuildJob: "ref, sync-all=true"
    BuildJob-->>PublishJob: docs-html artifact (_build/html)
    PublishJob->>PublishJob: "checkout FW-CI-templates@v0.74.0"
    PublishJob->>S3: upload docs (s3-target-path: nemo/emerging-optimizers)
    PublishJob->>Akamai: publish versioned or latest dir
    PublishJob-->>Trigger: send notification email (if configured)
Loading

Reviews (2): Last reviewed commit: "Add release docs workflow" | Re-trigger Greptile

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
@chtruong814 chtruong814 merged commit 41d3ea4 into NVIDIA-NeMo:main May 29, 2026
28 checks passed
skyw added a commit that referenced this pull request Jun 1, 2026
* docs: Update docs version for 0.3.0



* Add release docs workflow



---------

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Co-authored-by: Charlie Truong <chtruong@nvidia.com>
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