contribute-docs

Solid

Contribute documentation or example changes that stay aligned with NeMo Relay public behavior

AI & Automation 122 stars 57 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 86/100

Stars 20%
70
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Contribute Docs Or Examples ## Companion Guidance Use `karpathy-guidelines` alongside this skill for implementation or review work. Keep changes scoped, surface assumptions, and define focused validation before editing. Use this skill for 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 in docs/examples should use `compat.relay = ">=0.5,<1.0"` unless deliberately narrower. - 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 fo...

Details

Author
NVIDIA
Repository
NVIDIA/NeMo-Relay
Created
4 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