Skip to content

[DOCS-13278] Add NDM Summary Page documentation#36509

Draft
domalessi wants to merge 4 commits intomasterfrom
domalessi/ndm-summary-page
Draft

[DOCS-13278] Add NDM Summary Page documentation#36509
domalessi wants to merge 4 commits intomasterfrom
domalessi/ndm-summary-page

Conversation

@domalessi
Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Fixes DOCS-13278

Adds a new documentation page for the Network Device Monitoring (NDM) Summary Page, a command-center view for network engineers that surfaces device and interface health, top issues, traffic, and recent configuration changes.

The page covers:

  • Filtering and time range
  • Network health (with Bits AI summary)
  • Issues
  • Interface performance (with health threshold table)
  • Device performance (with health threshold table)
  • Traffic
  • Recent configuration changes

Also adds a nextlink from the NDM section index and a side nav entry at the top of the NDM section.

Open items before merge:

  • The screenshot is currently a design mockup placeholder. Replace with real product captures from staging once the feature is available.
  • Needs tech review for accuracy (default sort, table sizes, NetFlow source for Traffic, 1hr default time range, Bits AI card behavior).

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Document the new Network Device Monitoring Summary Page, including
filters, network health, interface and device performance with
threshold tables, traffic, and recent configuration changes. Add the
page to the NDM section index and the side nav.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

domalessi and others added 3 commits May 6, 2026 14:48
Trim UI inventory descriptions and add framing intros to the threshold
tables. Add placeholder screenshots for the filter bar, network health,
status counters, issues, interface performance, device performance,
traffic, and changes sections. Placeholders are sourced from design
mockups and need to be swapped for real product captures.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Move Summary Page from above Setup to below Setup in the NDM left
nav, renumbering downstream NDM siblings.

Editorial fixes:
- Recast overview to avoid implying recent changes have a "health"
- Clarify "Each top-level section on the page reports..."
- Drop confusing "(up to 100)" parentheticals from Interface and
  Device performance sections
- Bold UI labels (CPU, Memory) consistently in the default sort note
- Remove inappropriate commas before "and"/"or" with two items
- Match repo convention with "Further Reading" capitalization
- Trim long alt text on Interface and Device performance images
- Move filter bar image to follow both filter and time picker
  descriptions, since the image illustrates both

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The paragraph and image were captioning UI elements already visible
in the surrounding network_health.png and hero summary_page.png
images. Removing them tightens the Network health section without
losing meaningful context.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant