Skip to main content

File and Folder Names

This page describes how to format file and folder names in documentation.

To help with readability, folder and file names should be:

  • Lowercase
  • Written in chain case / kebab case
  • Follow naming that matches heading guidelines:
    • Verb phrases for docs that help the user achieve a task
    • Noun phrases for docs that aren't primarily about doing a task

Examples​

The following are some examples of file and folder naming:

  • With a product name:
    • getting-started-auditor.mdx
    • scalardb-graphql/how-to-run-two-phase-commit-transaction.mdx
  • Without a product name:
    • getting-started.mdx
    • add-scalardb-to-your-build.mdx

Category indexes​

Category indexes file names should match the section in which they're in. For example, the category index for the Deploy category should be deploy.mdx and the category index for Run Transactions in the Develop category should be develop-run-transactions.mdx