Skip to content

File Names ​

A file is named after its title, in lowercase, with a dash between the words.

Why ​

A name that follows the title can be guessed, reads well in a link, and sorts the same way the titles do.

How To Apply ​

  • Use lowercase letters, and a dash between words.
  • Use no spaces, underscores or capitals.
  • Name the file after the title of the page: always-work-from-a-plan.md for Always Work From A Plan.
  • Rename the file when the title changes, and update every link to it.
  • A file that a tool looks for by name keeps that name, such as AGENTS.md.
  • A file whose name a template fixes keeps it: an overview.md, a spec, a dated or versioned record. A ticket's file leads with its id.