docs: planner 3-tier documentation restructure

[athreesh]

Summary

Applies a 3-tier documentation hierarchy to the Planner component as a model migration template for all other Dynamo components. Also mirrors the new docs into the fern/ directory for the Sphinx-to-Fern migration.

Planner 3-Tier Documentation

Tier 1 — Component README (redirect stub)

• components/src/dynamo/planner/README.md: Updated redirect stub with links to Tier 2 + Tier 3

Tier 2 — User-facing docs (docs/planner/ + fern/pages/planner/)

• README.md / planner-intro.md: Overview, feature matrix, quick start, config reference
• planner_guide.md / planner-guide.md: Deployment, DGDR workflow, configuration, load predictors, virtual connector, Prometheus setup, troubleshooting
• planner_examples.md / planner-examples.md: DGDR YAML examples (AIC, online, MoE, ConfigMap, mocker), advanced patterns (warm-start, Kalman tuning, virtual connector)

Tier 3 — Design docs (docs/design_docs/ + fern/pages/design-docs/)

• planner_design.md / planner-design.md: Architecture, scaling algorithm with formulas, connector design, performance interpolation, known limitations, future work

Fern navigation

• Updated fern/versions/next.yml to include Planner Guide, Planner Examples, and Planner Design pages

All content from the original planner docs (867 lines) is preserved and redistributed across the new structure.

Where should the reviewer start?

• docs/planner/README.md — Tier 2 overview
• docs/planner/planner_guide.md — Tier 2 deployment guide
• fern/versions/next.yml — nav changes

Summary by CodeRabbit

• Documentation
  • Added comprehensive Planner documentation with deployment prerequisites, SLA configuration, and profiling options (online and offline methods)
  • Included deployment examples covering basic setups, Kubernetes deployments, custom configurations, load predictors, and virtual connector usage
  • Added design documentation detailing architecture, scaling algorithms, connector interfaces, and performance considerations
  • Updated documentation navigation with new Planner guide, examples, and design references

[copy-pr-bot]

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.

[Jont828]

Hi @athreesh! We're currently migrating our docs from Sphinx (docs/) to Fern (fern/).

Could you please also apply your changes to the corresponding file(s) in fern/pages/? Here's an idea on where to migrate the files:

docs/ file	suggested fern/ location
docs/design_docs/planner_design.md	fern/pages/design-docs/planner-design.md (new file)
docs/planner/README.md	fern/pages/planner/ (check for overlap with existing files)
docs/planner/planner_examples.md	fern/pages/planner/planner-examples.md (new file)
docs/planner/planner_guide.md	fern/pages/planner/planner-guide.md (new file)

Note: The fern/pages/planner/ folder already has some files (planner-intro.md, sla-planner.md, etc.). Please review how your new content fits with the existing structure and update fern/versions/next.yml accordingly. This is a suggestion - please verify this is the right approach.

Thanks for helping keep both doc sets in sync during the migration!

[coderabbitai]

Walkthrough

Documentation for the Planner autoscaling component is added across multiple directories. Changes include a README update for the component, new design documentation files, comprehensive user guides and examples for deployment and configuration, and navigation entries to support the documentation structure.

Changes

Cohort / File(s)	Summary
Component README Update components/src/dynamo/planner/README.md	Replaced reference to planner_intro.rst with new Planner overview section describing SLA-driven autoscaling controller with links to user and design documentation.
Design Documentation docs/design_docs/planner_design.md, fern/pages/design-docs/planner-design.md	Added comprehensive design documentation covering Planner architecture, scaling algorithm workflow, PlannerConnector interfaces (KubernetesConnector and VirtualConnector), interpolation strategies, performance considerations, and limitations.
User Guides and Examples docs/planner/README.md, docs/planner/planner_guide.md, docs/planner/planner_examples.md, fern/pages/planner/planner-guide.md, fern/pages/planner/planner-examples.md	Added comprehensive documentation including README with feature overview, deployment guide covering DGDR workflow and configuration (SLAs, profiling, load predictors, monitoring), and extensive examples for various deployment scenarios (Kubernetes, MoE, virtual connector, advanced customization).
Navigation Configuration fern/versions/next.yml	Added three navigation entries for new Planner documentation pages (Guide, Examples, and Design Docs) under respective sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A planner's tale in docs so fine,
SLA metrics in a perfect line,
With examples clear and guides so bright,
The Planner's path is set just right!
From graphs to replicas, we hop with glee,
Autoscaling at velocity! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: reorganizing Planner documentation into a 3-tier structure.
Description check	✅ Passed	The description covers all required sections (overview, details, reviewer start points) and thoroughly explains the 3-tier restructure with specific file locations and Fern mirroring.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

🤖 Fix all issues with AI agents

In `@fern/pages/design-docs/planner-design.md`:
- Line 191: The bullet "30-second startup delay: Hardcoded wait for component
registration. Should be replaced with runtime readiness probing." contains a
sentence fragment; update the second sentence so it has a clear subject (e.g.,
"This should be replaced with runtime readiness probing" or "We should replace
it with runtime readiness probing") to make the bullet a complete, grammatical
statement referring to the hardcoded wait for component registration.
- Around line 61-64: Update the Markdown code fence that contains the correction
formulas so it includes a language tag (use "text") after the opening ```;
specifically change the fence surrounding the lines with prefill_correction =
actual_ttft / expected_ttft and decode_correction  = actual_itl  / expected_itl
to start with ```text instead of ```, leaving the content unchanged.
- Around line 16-44: Locate the ASCII architecture diagram fenced code block in
planner-design.md (the large "Planner Component" diagram) and change its opening
code fence from ``` to ```text so the fence includes the language tag; ensure
the closing fence remains ``` and no other diagram content is modified.

In `@fern/pages/planner/planner-examples.md`:
- Line 237: The link "Model Cache PVC" in planner-examples.md points to a
non-existent anchor (`#model-cache-pvc-advanced`) in
../benchmarks/sla-driven-profiling.md; either update the anchor in
planner-examples.md to an existing section anchor from sla-driven-profiling.md
or add a matching section heading ("Model Cache PVC" or "Model Cache PVC —
Advanced") with that anchor to sla-driven-profiling.md so the link resolves;
locate the link text in planner-examples.md and the section headings in
sla-driven-profiling.md to make the change.

🧹 Nitpick comments (2)

fern/pages/planner/planner-examples.md (1)

93-93: Consider simplifying the phrasing.

"Prior to 0.8.1" could be simplified to "Before 0.8.1" for easier reading.

docs/planner/planner_examples.md (1)

88-88: Consider simplifying the phrasing.

"Prior to 0.8.1" could be simplified to "Before 0.8.1" for easier reading.

[dagil-nvidia]

/ok to test d399361

[dagil-nvidia]

/ok to test 84ad3dd