Skip to content

Document that the dali-dynamic-mode skill exists#6358

Open
rostan-t wants to merge 3 commits into
NVIDIA:mainfrom
rostan-t:ndd-skill-doc
Open

Document that the dali-dynamic-mode skill exists#6358
rostan-t wants to merge 3 commits into
NVIDIA:mainfrom
rostan-t:ndd-skill-doc

Conversation

@rostan-t
Copy link
Copy Markdown
Collaborator

@rostan-t rostan-t commented May 20, 2026

Category:

Other (e.g. Documentation, Tests, Configuration)

Description:

Point to the dali-dynamic-mode skill in NVIDIA/skills in the documentation.

Additional information:

Affected modules and functionalities:

Dynamic API Overview documentation page:
Capture d’écran 2026-05-20 à 14 25 46

Key points relevant for the review:

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: N/A

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 20, 2026

Greptile Summary

This PR adds documentation pointing to the dali-dynamic-mode skill in the NVIDIA/skills repository, giving AI agents discoverable guidance on the Dynamic Mode API.

  • docs/dali_dynamic/overview.rst: Inserts a .. tip:: admonition with a named external link to the skill's SKILL.md and an npx skills add install snippet.
  • README.rst: Adds a dual-display block — a raw-HTML <details class="github-only"> element (hidden in Sphinx via injected CSS) alongside a .. only:: not github tip block (visible in Sphinx builds) — so GitHub and the rendered docs each show an appropriately styled version of the same information.

Confidence Score: 5/5

Documentation-only change with no runtime code; safe to merge.

Both files contain only RST prose additions — no logic, no API changes, no build-system modifications. The named external links follow correct RST syntax, the dual-display mechanism in README.rst is self-contained, and no TODOs or placeholder text were introduced.

No files require special attention.

Important Files Changed

Filename Overview
docs/dali_dynamic/overview.rst Adds a tip admonition pointing to the dali-dynamic-mode skill with install instructions; RST named-link syntax is correct.
README.rst Adds dual-display block: GitHub-visible raw HTML
Details with CSS hide-on-Sphinx trick, plus a Sphinx-only tip admonition; links and RST formatting are correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.rst rendered] --> B{Renderer}
    B -->|GitHub.com| C[raw HTML details block visible\ndali-dynamic-mode link shown]
    B -->|Sphinx HTML build| D[CSS injects display:none\nfor .github-only class]
    D --> E[details block hidden]
    D --> F[only:: not github tip rendered\nwith install snippet]

    G[docs/dali_dynamic/overview.rst] --> H[tip:: admonition\ndali-dynamic-mode link + install snippet]
Loading

Reviews (9): Last reviewed commit: "GitHub WAR to properly show the tip box" | Re-trigger Greptile

Comment thread docs/dali_dynamic/overview.rst Outdated
Signed-off-by: Rostan Tabet <rtabet@nvidia.com>
@rostan-t
Copy link
Copy Markdown
Collaborator Author

!build

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [51951217]: BUILD STARTED

@JanuszL JanuszL self-assigned this May 20, 2026
@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [51951217]: BUILD PASSED

@JanuszL
Copy link
Copy Markdown
Contributor

JanuszL commented May 21, 2026

@rostan-t - how about adding this note also to the readme, maybe just above the examples and after the about section?

Signed-off-by: Rostan Tabet <rtabet@nvidia.com>
@rostan-t rostan-t force-pushed the ndd-skill-doc branch 6 times, most recently from e0f987b to 6ef9c45 Compare May 26, 2026 15:23
Signed-off-by: Rostan Tabet <rtabet@nvidia.com>
@rostan-t
Copy link
Copy Markdown
Collaborator Author

@rostan-t - how about adding this note also to the readme, maybe just above the examples and after the about section?

What about efbc486? GitHub's RST renderer doesn't handle admonition so I workaround it to show a collapsible on GitHub instead and a proper .. tip in the documentation.

@rostan-t
Copy link
Copy Markdown
Collaborator Author

!build

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [52661253]: BUILD STARTED

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [52661253]: BUILD PASSED

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants