Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

For Documentation

Are user-facing docs and compatibility artifacts correct, current, and well-written?

This is the index of the documentation guidelines. Each subsection is its own page, and each entry below links a stable short-name to its guideline, with a one-line gist so a reader (or a review tool) can grasp the guideline before opening it.

Index

General Style

  • semantic-line-breaks: Break prose at sentence/clause boundaries, one idea per line.
  • readme-as-crate-doc: For a published crate, make README.md the crate-level doc (#![doc = include_str!("../README.md")]) so crates.io and docs.rs stay in sync.

Path-Specific

  • kernel/
    • linux-compat-docs: When a user-visible API (syscall or kernel parameter) changes, update the Linux Compatibility docs (Syscall Flag Coverage + .scml, or Kernel Parameters).