Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .github/workflows/fern-docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:
branches:
- "pull-request/[0-9]+"
paths:
- 'fern/**'
- 'docs/fern/**'
- '.github/workflows/fern-docs-ci.yml'

permissions:
Expand All @@ -47,5 +47,5 @@ jobs:
run: npm install -g fern-api

- name: Validate Fern configuration
working-directory: ./fern
working-directory: ./docs/fern
run: fern check
6 changes: 3 additions & 3 deletions .github/workflows/fern-docs-preview-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

# Workflow 1 of 2 for Fern doc previews.
#
# Collects the fern/ sources and PR metadata from the (possibly untrusted) PR
# Collects the docs/fern/ sources and PR metadata from the (possibly untrusted) PR
# branch and uploads them as an artifact. No secrets are used here, so this is
# safe to run on fork PRs via the regular pull_request trigger.
#
Expand All @@ -27,7 +27,7 @@ name: "Preview Fern Docs: Build"
on:
pull_request:
paths:
- 'fern/**'
- 'docs/fern/**'
- '.github/workflows/fern-docs-preview-build.yml'

permissions:
Expand Down Expand Up @@ -58,6 +58,6 @@ jobs:
with:
name: fern-preview
path: |
fern/
docs/fern/
preview-metadata/
retention-days: 1
4 changes: 2 additions & 2 deletions .github/workflows/fern-docs-preview-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Workflow 2 of 2 for Fern doc previews.
#
# Triggered by workflow_run after "Preview Fern Docs: Build" completes.
# Downloads the fern/ artifact, builds a preview with DOCS_FERN_TOKEN, and
# Downloads the docs/fern/ artifact, builds a preview with DOCS_FERN_TOKEN, and
# posts a stable :herb: comment on the PR. This workflow never checks out the
# PR branch directly, keeping secrets isolated from untrusted code.
#
Expand Down Expand Up @@ -65,7 +65,7 @@ jobs:
env:
FERN_TOKEN: ${{ secrets.DOCS_FERN_TOKEN }}
HEAD_REF: ${{ steps.metadata.outputs.head_ref }}
working-directory: ./fern
working-directory: ./docs/fern
run: |
OUTPUT=$(fern generate --docs --preview --id "$HEAD_REF" 2>&1)
echo "$OUTPUT"
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/publish-fern-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ on:
- main
paths:
- 'docs/**'
- 'fern/**'
tags:
- 'docs/v*'
workflow_dispatch: {}
Expand Down Expand Up @@ -59,5 +58,5 @@ jobs:
- name: Publish Docs
env:
FERN_TOKEN: ${{ secrets.DOCS_FERN_TOKEN }}
working-directory: ./fern
working-directory: ./docs/fern
run: fern generate --docs
77 changes: 6 additions & 71 deletions .github/workflows/release-freeze.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,74 +49,9 @@ jobs:
SLACK_WEBHOOK_ADMIN: ${{ secrets.SLACK_WEBHOOK_ADMIN }}
PAT: ${{ secrets.PAT }}

bump-docs-versions:
needs: [code-freeze]
runs-on: ubuntu-latest
env:
VERSION: ${{ needs.code-freeze.outputs.release-branch }}
DRY_RUN: ${{ inputs.dry-run }}
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
ref: main
token: ${{ secrets.PAT }}

- name: Configure git
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

- name: Update versions1.json
run: |
version_number=$(echo ${VERSION} | sed 's/^r//')

# Remove (latest) tag from previous latest entry, insert new version after nightly
jq --arg ver "$version_number" '
map(if .name then del(.name) else . end)
| [.[0]] + [{"name": ($ver + " (latest)"), "version": $ver, "url": "https://docs.nvidia.com/nemo/automodel/latest/"}] + .[1:]
' docs/versions1.json > tmp.json && mv tmp.json docs/versions1.json

- name: Commit changes
id: commit-versions1
run: |
git add docs/versions1.json
git commit -m "[bot]: Update docs-versions after code-freeze for ${VERSION}"
commit_hash=$(git rev-parse HEAD)
echo "commit_hash=${commit_hash}" | tee -a $GITHUB_OUTPUT

if [[ "$DRY_RUN" != "true" ]]; then
git push
fi

- name: Switch to release branch
run: |
git fetch origin ${{ needs.code-freeze.outputs.release-branch }}
git checkout ${{ needs.code-freeze.outputs.release-branch }}

- name: Cherry-pick docs-versions commit
run: |
git cherry-pick ${{ steps.commit-versions1.outputs.commit_hash }}

- name: Update project.json
run: |
version_number=$(echo ${VERSION} | sed 's/^r//')

jq --arg ver "$version_number" \
'. = {"version": $ver, "name": "nemo-automodel"}' \
docs/project.json > tmp.json && mv tmp.json docs/project.json

- name: Update conf.py
run: |
version_number=$(echo ${VERSION} | sed 's/^r//')
sed -i "s/release = .*/release = \"${version_number}\"/" docs/conf.py

- name: Commit changes
run: |
git add docs/project.json
git add docs/conf.py
git commit -m "Bump docs version to ${VERSION}"

if [[ "$DRY_RUN" != "true" ]]; then
git push
fi
# bump-docs-versions: the Sphinx-era docs/versions1.json, docs/project.json,
# and docs/conf.py no longer exist; Fern manages version metadata via
# docs/fern/docs.yml `versions:` and docs/fern/versions/*.yml. The
# equivalent step under Fern is to add a new version pin in those files
# and tag docs/v<X>.<Y>.0 to trigger publish-fern-docs.yml — done by hand
# at release cut time, not on every code freeze.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,6 @@ skypilot_jobs/

# Fern: generated library reference (regenerated by `fern docs md generate`
# during preview / publish — not committed)
fern/product-docs/
docs/fern/product-docs/

training_logs/
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ file gives step-by-step instructions an AI agent can follow.
| 7 | build-and-dependency | `build-and-dependency` | Container setup, uv package management, environment variables, CLI usage |
| 8 | cicd | `cicd` | Commit/PR workflow, CI trigger mechanism, failure investigation |
| 9 | testing | `testing` | Unit and functional test layout, tier semantics (L0/L1/L2), adding tests |
| 10 | fern-docs | `fern-docs` | Maintain the Fern docs site under `fern/` — pages, slugs, redirects, version aliases, library reference |
| 10 | fern-docs | `fern-docs` | Maintain the Fern docs site under `docs/` (MDX content) + `docs/fern/` (infra) — pages, slugs, redirects, version aliases, library reference |

**Always read the relevant `SKILL.md` before starting any task it covers —
skills are mandatory context, not optional background reading.**
Expand Down
101 changes: 0 additions & 101 deletions docs/about/index.md

This file was deleted.

File renamed without changes.
Loading
Loading