mirror of
https://github.com/NVIDIA/skills.git
synced 2026-09-14 15:41:50 +08:00
1f57dcb34d
Aligns author-facing checklist and pipeline docs with SkillEvaluator’s staged Tier 1 tree so authors can reproduce gate findings without degrading eval fixtures. Fixes #401. Signed-off-by: Atirna <288419661+atirna@users.noreply.github.com>
Documentation
Long-form documentation for the NVIDIA Agent Skills catalog. Pages are authored in MDX and published to https://docs.nvidia.com/skills.
Layout
index.mdx— landing pageadvanced-install.mdx— advanced skills CLI usageagent-skill-trust-pipeline.mdx— trust pipeline overviewscanning-agent-skills.mdx— pre-install scanning guidesigning-agent-skills.mdx— signature verification guideskill-cards.mdx— Skill Card authoring guiderelease-checklist.mdx— release process
Navigation order and slugs are defined in ../fern/docs.yml.
Build Locally
You only need to build locally if you are editing the documentation. The site is published automatically from main via the Fern GitHub integration.
Prerequisites: Node.js 18+ and npm.
# Install the Fern CLI
npm install -g fern-api
# From the repo root, preview the site with live reload
fern docs dev
# Validate the docs configuration and links
fern check
fern docs dev serves the site at http://localhost:3000 and reloads on changes to .mdx files or fern/docs.yml.
Authoring Notes
- New pages must be added to the
navigationsection of../fern/docs.yml; otherwise they will not appear in the site. - Use relative links between MDX pages (
./skill-cards.mdx) and absolute repo links (/components.d/README.md) for files outsidedocs/. - The Fern version is pinned in
../fern/fern.config.json; bump it intentionally rather than as a side effect.