contribute-docs
Contribute documentation or example changes that stay aligned with NeMo Fabric public behavior
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-14
- Stars
- ★ 75
- Forks
- 47
01 前言 Front Matter
- name
- contribute-docs
- author
- NVIDIA Corporation and Affiliates
- license
- Apache-2.0
- description
- Contribute documentation or example changes that stay aligned with NeMo Fabric public behavior
03 SKILL.md 正文
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
- Update entry-point docs when examples or reading paths change
- Keep release-process and release-history policy in
RELEASING.md, not in user-facing docs or a duplicateCHANGELOG.md - When writing new documentation, add a
\nnewline character only to intentionally start a new paragraph or add space around a code block or section heading. Do not enforce a line length. Apply this only to newly written text or the paragraph being edited; do not reformat an entire document to conform. - 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.
Checklist
- [ ]
README.mdordocs/index.ymlupdated when entry points changed - [ ] Relevant getting-started or reference docs updated
- [ ] Example commands still match current package names and paths
- [ ] Relevant adapter or example
README.mdfiles updated when examples or adapters have changed. - [ ] New or regenerated MDX files use
{/* ... */}for top-of-file SPDX comments - [ ] Run
just docswhen the docs site changed - [ ] Parse and render changed Mermaid diagrams with Mermaid; Fern configuration and link checks do not validate diagram syntax
References
README.mdRELEASING.mddocs/index.ymlreview-doc-style
04 同仓库更多 Skills
default
Use this skill when asked to load the default test skill.
alternate
Use this skill when asked to load the alternate test skill.
swebench-debugging
Apply a focused reproduce-fix-test workflow to SWE-Bench repository tasks.
code-review
Review Python changes for correctness risks and missing test coverage.
validate-change
Choose and run the right NeMo Fabric validation matrix for a change instead of using one fixed test list
update-project-version
Update the NVIDIA NeMo Fabric release version across Cargo, Python, and TypeScript package metadata, internal Python dependency pins, integration metadata, and lockfiles. Use when bumping, synchronizing, or auditing NeMo Fabric package versions for a release.