contribute-docs
Contribute documentation or example changes that stay aligned with NeMo Fabric public behavior
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-12
- Stars
- ★ 4
- Forks
- 0
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
agentic-ecology-ui
Guidelines and templates for creating a generic web UI to visualize, rank, filter, and annotate vector databases. The UI has a hierarchical structure covering database selection, label selection/definition, ranking/filtering configuration, and row visualization/annotation. Use when building, serving, or adapting an interactive web UI for Hoplite vector databases.
agentic-ecology-init
Initializes a local uv-managed project directory for agentic ecology workloads. Sets up Python dependencies using reference pyproject.toml and uv.lock, configures workspace rules, and ensures Agentic Ecology skills are discoverable. Use when initializing a new project workspace or bootstrapping a clean environment.
agentic-ecology-camera-traps
Provides capabilities to run SpeciesNet detector and classifier on camera trap images, extract crop-level feature embeddings, and populate a Hoplite vector database for downstream search and agile modeling. Use when ingesting camera trap images, classifying wildlife photos, or indexing camera trap data.
agentic-ecology-bioacoustics
Provides bioacoustic analysis capabilities for ecologists and researchers using the perch-hoplite Python package. A typical use case is to use agile modeling to bootstrap the creation and deployment of a bespoke detector for targeted species on an existing collection of passive acoustic monitoring recordings. Use when processing and annotating audio recordings for bioacoustic applications.
sample-skill
Sample skill used by agent-env integration tests. Exercises SKILL.md parsing plus supporting scripts and references.
simready-foundation-validate-foundation-change
Use for auditing SimReady requirement, validator, feature, profile, adapter, test, and skill consistency.