contribute-docs

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 duplicate CHANGELOG.md
• When writing new documentation, add a \n newline 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.md or docs/index.yml updated 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.md files updated when examples or adapters have changed.
• New or regenerated MDX files use {/* ... */} for top-of-file SPDX comments
• Run just docs when the docs site changed

References

• README.md
• RELEASING.md
• docs/index.yml
• review-doc-style