Skip to content

docs: publish insight-driven optimization guide - #1124

Merged
miyoungc merged 3 commits into
mainfrom
publish-insight-optimization-docs/miyoungc
Aug 7, 2026
Merged

docs: publish insight-driven optimization guide#1124
miyoungc merged 3 commits into
mainfrom
publish-insight-optimization-docs/miyoungc

Conversation

@miyoungc

@miyoungc miyoungc commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Publish the Insight-Driven Optimization guide in the Latest documentation navigation. Group it with the existing optimizer how-to beneath an expandable Optimize Agents node, and align the optimizer page title with its Run the Agent Optimizer sidebar label.

Changes

  • Replace the linked Optimize Agents page node with an expandable section.
  • Nest Run the Agent Optimizer and Insight-Driven Optimization beneath that section.
  • Apply Run the Agent Optimizer to the optimizer page title as well as its sidebar label.
  • Remove the Insight-Driven Optimization reference from the gated navigation file so Fern builds and serves the guide.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: This change only updates Fern navigation, publication state, and page metadata; the documentation checks validate that behavior.
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

  • make docs-check — passed with 0 Fern errors; 216 MDX files parsed cleanly.
  • make docs-broken-links — completed and reported five existing unrelated broken links in telemetry/privacy, authentication, and Studio pages; none target either optimization guide.
  • Full repository pre-commit suite using repository-compatible uv 0.9.17 and the worktree .venv — passed all hooks, including Studio lint-staged.
  • Repository DCO audit — passed for all three commits in the PR range.
  • git diff --check origin/main...HEAD — passed.

@github-actions github-actions Bot added the docs label Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 31438/40061 78.5% 63.0%
Integration Tests 18310/38013 48.2% 20.8%

@miyoungc
miyoungc marked this pull request as ready for review August 7, 2026 01:05
@miyoungc
miyoungc requested review from a team as code owners August 7, 2026 01:05
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The Agents navigation now groups the Agent Optimizer and Insight-Driven Optimization pages under Optimize Agents. The gated navigation entry was removed. The Agent Optimizer page title now reads “Run the Agent Optimizer.”

Changes

Agents navigation

Layer / File(s) Summary
Group published optimization pages
docs/fern/versions/latest.yml, docs/fern/gated-nav.yml, docs/agents/optimization.mdx
The latest navigation groups both optimization pages under Optimize Agents. The gated navigation entry was removed. The page title was updated to “Run the Agent Optimizer.”

Possibly related PRs

Suggested reviewers: jeremysilva1098, nicot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes publishing the Insight-Driven Optimization guide, which is the main change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch publish-insight-optimization-docs/miyoungc

Comment @coderabbitai help to get the list of available commands.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc
miyoungc force-pushed the publish-insight-optimization-docs/miyoungc branch from 0aebf30 to 38c3843 Compare August 7, 2026 01:20
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@miyoungc
miyoungc added this pull request to the merge queue Aug 7, 2026
Merged via the queue into main with commit 874be47 Aug 7, 2026
57 checks passed
@miyoungc
miyoungc deleted the publish-insight-optimization-docs/miyoungc branch August 7, 2026 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants