Planning

Categories

Sort your documents into sections your readers will recognize.

Categories sort your documents into sections your readers will recognize, like "Guides", "News" or "Changelog". Your website can fetch them and list the documents in each one.

Categories or clusters?#

Both group documents, but for different people:

  • Categories are for readers. They usually become sections of your website.
  • Clusters are for planning. They track how well you cover a topic. See Topic clusters.

A document can have one of each.

Create a category#

  1. Choose Categories in the sidebar.
  2. Choose New category.
  3. Fill in the fields:
    • Name: what readers see, like "Comparisons".
    • Slug: used in the category's URL. It follows the name until you edit it.
    • Parent category: pick one to nest this category under it, or leave it at None.
    • Description: shown on the category page and read by agents as context.
  4. Choose Create.

Tip: Write the description for both readers and agents. When an agent claims a brief, it gets the category's description, so "Hands-on guides for developers, with code samples" steers the writing better than "Guides".

Slug rules#

A slug uses lowercase letters, numbers and single hyphens only, like ai-technology. Each category in a project needs its own slug. If it's taken, you'll see "Another category already uses this slug. Pick a different one."

Put a document in a category#

Open the document and pick a Category in its details panel. You can also set it while creating a new document.

Edit or delete a category#

  1. On the Categories page, choose the category.
  2. Change what you need and choose Save changes.

To delete it, choose Delete on the same page, then Delete category to confirm.

Warning: Deleting a category can't be undone. Its documents end up with no category, and its subcategories become top-level categories.

For developers#