contribute-docs
FeaturedAuthor or edit NeMo Relay documentation or examples when repository-specific MDX, public API, integration, or release-history conventions matter. Do not use for review-only requests or incidental prose edits in code.
AI & Automation 177 stars
75 forks Updated today Apache-2.0
Install
Quality Score: 90/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Contribute Docs Or Examples
Use this skill when authoring docs-only or example-heavy changes.
## Rules
- Prefer the documented public API, not internal shortcuts
- Keep package names, repo references, and build commands current
- When documenting contribution workflow, require an issue before external contribution PRs and note that NVIDIA contributors may use a GitHub or Linear issue.
- Update entry-point docs when examples or reading paths change
- Keep release-process and release-notes guidance in repo-maintainer docs such as
`RELEASING.md`, not as user-facing docs pages or `CHANGELOG.md`
- Keep stable user-facing wrappers at `scripts/` root in docs and examples;
only point at namespaced helper paths when documenting internal maintenance
work
- When detailed dynamic plugin guides exist, keep Rust native plugin examples,
Python worker plugin examples, and `grpc-v1` protocol details on separate
pages.
- Dynamic plugin manifests must exclude Relay versions before 0.8. Recommend
`compat.relay = ">=0.8.0,<1.0"`; open-ended or narrower 0.8-or-newer ranges
are valid when intentional.
- In MDX files, top-of-file comments must use JSX comment delimiters:
`{/*` to open and `*/}` to close. Do not use HTML comments for MDX SPDX
headers.
- Render images, diagrams, tables, and other visual content at representative
page widths. Size visual content for legibility and complete access without
clipping. Choose responsive scaling, reflow, or overflow based on the co...
Details
- Author
- NVIDIA
- Repository
- NVIDIA/NeMo-Relay
- Created
- 5 months ago
- Last Updated
- today
- Language
- Rust
- License
- Apache-2.0
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Featured
review-doc-style
Review NeMo Relay documentation, examples, or public text for NVIDIA technical writing style, terminology, and repository accuracy. Do not use for ordinary implementation review.
177 Updated today
NVIDIA AI & Automation Featured
contribute-api
Contribute a new NeMo Relay public API surface safely, with binding parity and docs in mind
177 Updated today
NVIDIA AI & Automation Featured
contribute-integration
Add or change a third-party framework integration that attaches NeMo Relay to framework tool, LLM, or lifecycle boundaries. Do not use for core runtime or binding-only changes.
177 Updated today
NVIDIA