docs: add changelog

.github/workflows/fern-docs-preview-build.yml

@@ -15,7 +15,7 @@
 
 # Workflow 1 of 2 for Fern doc previews.
 #
-# Collects fern/, docs/, rest-api/openapi/, and PR metadata and uploads an artifact.
+# Collects Fern's source inputs and PR metadata and uploads an artifact.
 #
 # The companion workflow (fern-docs-preview-comment.yml) runs after this one;
 # it skips cleanly when no artifact exists (e.g. skipped fork pull_request).
@@ -27,6 +27,7 @@ on:
     paths:
       - 'fern/**'
       - 'docs/**'
+      - 'rest-api/flow/docs/**'
       - 'rest-api/openapi/**'
       - '.github/workflows/fern-docs-preview-build.yml'
   push:
@@ -35,6 +36,7 @@ on:
     paths:
       - 'fern/**'
       - 'docs/**'
+      - 'rest-api/flow/docs/**'
       - 'rest-api/openapi/**'
       - '.github/workflows/fern-docs-preview-build.yml'
 
@@ -56,19 +58,20 @@ jobs:
 
       - name: Save PR metadata
         env:
+          BASE_REF: ${{ github.base_ref }}
           DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
         run: |
           mkdir -p preview-metadata
           if [ "${{ github.event_name }}" = "pull_request" ]; then
             echo "${{ github.event.pull_request.number }}" > preview-metadata/pr_number
             echo "${{ github.head_ref }}" > preview-metadata/head_ref
-            git diff --name-only "origin/${{ github.base_ref }}...HEAD" -- '*.md' > preview-metadata/changed_md_files 2>/dev/null || true
+            git diff --name-only "origin/${BASE_REF}...HEAD" -- '*.md' '*.mdx' > preview-metadata/changed_md_files 2>/dev/null || true
           else
             # copy-pr-bot push to pull-request/<n> (no pull_request payload on push)
             branch="${GITHUB_REF_NAME}"
             echo "${branch#pull-request/}" > preview-metadata/pr_number
             echo "${branch}" > preview-metadata/head_ref
-            git diff --name-only "origin/${DEFAULT_BRANCH}...HEAD" -- '*.md' > preview-metadata/changed_md_files 2>/dev/null || true
+            git diff --name-only "origin/${DEFAULT_BRANCH}...HEAD" -- '*.md' '*.mdx' > preview-metadata/changed_md_files 2>/dev/null || true
           fi
 
       - name: Upload Fern docs inputs and metadata
@@ -78,6 +81,7 @@ jobs:
           path: |
             fern/
             docs/
+            rest-api/flow/docs/
             rest-api/openapi/
             preview-metadata/
           retention-days: 1

docs/.rumdl.toml

@@ -12,9 +12,8 @@
 
 [global]
 # List of rules to disable
-# disable = ["MD013", "MD014", "MD033", "MD036"]
+# disable = ["MD014", "MD033", "MD036"]
 disable = [
-  "line-length",
   "commands-show-output",
   "no-inline-html",
   "no-emphasis-as-heading",
@@ -61,11 +60,13 @@ respect-gitignore = true
 flavor = "mdx"
 
 [per-file-flavor]
-"**/*.md" = "standard"
+# Fern treats all files as MDX, so best to lint accordingly
+# "**/*.md" = "standard"
 
 # Disable specific rules for specific files
 [per-file-ignores]
 "**/snippets/**/*.mdx" = ["MD041"]  # Snippets don't need to start with an H1
+"fern/changelog/*.mdx" = ["MD041"]  # Changelog entries don't need to start with an H1
 
 # Rule-specific configurations
 
@@ -89,11 +90,12 @@ strict = false
 # no-hard-tabs
 spaces-per-tab = 4  # Number of spaces to replace each tab with (default: 4)
 
-# [MD013]
-# line-length = 100  # Line length
-# code-blocks = false  # Exclude code blocks from line length check
-# tables = false  # Exclude tables from line length check
-# headings = true  # Include headings in line length check
+[MD013]
+# line-length
+line-length = 100000      # make sure paragraph-length lines are allowed
+# line-length = 100
+# reflow = true
+# reflow-mode = "normalize"
 
 [MD024]
 # no-duplicate-heading
@@ -113,14 +115,16 @@ allow-with-separators = true    # Allow multiple H1s as document section titles
 # - "ordered0": Zero-based sequential (0, 1, 2...)
 # - "one-or-ordered": Auto-detect per list (either all-ones OR sequential)
 # - "consistent": Document-wide consistency - uses most common style across all lists
-style = "one-one"
+# TODO: move to "one-one" style when we can (except for files that are
+# going to be viewed in GitHub a lot)
+style = "consistent"
 
 [MD041]
 # first-line-heading
 level = 1
 
 [MD044]
-# names = ["NVIDIA Config Manager", "NVIDIA"]
+# names = ["NVIDIA Infra Controller", "NVIDIA"]
 # code-blocks = false
 
 [MD046]

docs/index.md

@@ -17,6 +17,6 @@ NICo is open source under the Apache 2.0 license.
 ## Quick Links
 
 - [Hardware Compatibility List](hcl.md) — Supported servers and DPUs
-- [Release Notes](release-notes.md) — What's new in each version
+- [Release Notes](/infra-controller/changelog) — What's new in each version
 - [FAQs](faq.md) — Common questions answered
 - [GitHub](https://github.com/NVIDIA/infra-controller)

docs/index.yml

@@ -16,6 +16,11 @@ navigation:
       path: index.md
       icon: home
 
+    - changelog: ../fern/changelog
+      title: Release Notes
+      icon: clock
+      slug: release-notes
+
     - section: Overview
       contents:
         - page: What is NICo?
@@ -285,8 +290,6 @@ navigation:
       contents:
         - page: Hardware Compatibility List
           path: hcl.md
-        - page: Release Notes
-          path: release-notes.md
         - page: Release and QA Process
           path: development/release_and_qa_process.md
         - page: FAQs

docs/overview/what-is-nico.md

@@ -84,7 +84,7 @@ For a deeper look at each component and the state machine design, see [Architect
 
 NICo sits below Kubernetes and platform layers. It exposes REST and gRPC APIs that higher-level systems — BMaaS, VMaaS, orchestration engines, ISV control planes — can consume directly. It does not dictate how scheduling, tenancy policy, or workloads are managed above it.
 
-```
+```text
 ┌─────────────────────────────────────┐
 │   ISV / NCP Control Plane           │
 ├─────────────────────────────────────┤