documentation-style

Enforce ASCII-only, bold-free Markdown documentation style across NVCF repos.

195|43|Updated Apr 1, 2026
One-click install
npx skills add https://github.com/NVIDIA/nvcf --skill documentation-style-nvidia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-style
Source: https://github.com/NVIDIA/nvcf/tree/main/ai-tooling/dev/skills/documentation-style
Command: npx skills add https://github.com/NVIDIA/nvcf --skill documentation-style-nvidia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This style guide standardizes NVCF documentation to be plain, ASCII-only, and grep-friendly, removing bold emphasis and non-ASCII characters.

Core Features & Use Cases

  • No markdown bold for emphasis; avoid non-ASCII punctuation and emoji.
  • ASCII-only prose that remains clear and consistent across root docs, READMEs, AGENTS.md, plans, and PR descriptions.
  • Useful for contributors who need to edit or author documentation quickly and keep a uniform voice.

Quick Start

Follow these rules when editing markdown to ensure ASCII-only prose and consistent formatting.

Frequently Asked Questions about documentation-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce ASCII-only documentation in markdown files?

To enforce ASCII-only documentation, remove non-ASCII characters, emojis, and markdown bold emphasis. This ensures plain, grep-friendly prose across all root docs, READMEs, and plans.

Why should I avoid markdown bold for emphasis in technical docs?

Avoiding markdown bold for emphasis keeps documentation plain and consistent. This style standardization removes visual clutter, ensuring text remains readable and uniform across NVCF repositories.

What is the best way to standardize README formatting across multiple repositories?

Standardize README formatting by applying a plain, ASCII-only style guide. This removes non-ASCII punctuation and bold text, ensuring a uniform voice and consistent readability across repositories.

Does this documentation style guide apply to PR descriptions and plans?

Yes, this documentation style guide applies to PR descriptions, plans, AGENTS.md, READMEs, and root docs. It enforces ASCII-only prose and consistent formatting across all these files.

How do I format YAML frontmatter for markdown documentation?

Format YAML frontmatter by specifying the name and description fields. This standardizes metadata at the top of markdown files to maintain consistency across documentation.

What are the limitations of using ASCII-only prose in markdown?

ASCII-only prose limitations include the inability to use non-ASCII punctuation or emojis. This constraint ensures text remains grep-friendly and clear but requires avoiding certain characters.