Configure categories

View as Markdown

---

Added in eventcatalog@2.x.0

When you group resource docs into subdirectories, each subdirectory becomes a section in the resource sidebar. By default, the section label is the folder name and sections are sorted alphabetically.

Categories let you customise this — you can give a group a friendlier display label and control the order it appears relative to other groups, without renaming the folder.

Category files

Place a category.json file inside any doc type folder to configure its sidebar label and position.

services/
└── OrdersService/
    └── docs/
        └── runbooks/
            ├── category.json
            ├── 01-deployment.md
            └── 02-incident-response.md

services/OrdersService/docs/runbooks/category.json

{
  "label": "Runbooks",
  "position": 1
}

Category file properties

Property	Required	Description
label	No	Display name for the doc type group in the sidebar.
position	No	Sort order of the group relative to other doc type groups.

Use _category_.json as an alternative

EventCatalog also accepts _category_.json as the file name. When both files exist in the same folder, category.json takes precedence.

Control group ordering

Set position on each group to control the order they appear in the sidebar. Groups without a position are sorted alphabetically after positioned groups.

docs/adrs/category.json

{
  "label": "Architecture decisions",
  "position": 1
}

docs/runbooks/category.json

{
  "label": "Runbooks",
  "position": 2
}