Skip to content

Commit 09e05e0

Browse files
committed
docs: correct required YAML fields and document type in editor guide
1 parent 005deaa commit 09e05e0

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

DOCS/guidelines/editor-manual_v1.qmd

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,20 @@ If you copied a template, the header is pre-filled - just update `title`, `subti
7676
---
7777
title: "HRL Forest"
7878
subtitle: "High Resolution Layer - Forest Type"
79+
category: products
7980
date: "2026-01-27"
80-
product-name: "HRL Forest"
8181
---
8282
```
8383

8484
- `title` - short product name, appears as the document title
8585
- `subtitle` - full product name or document type description
86+
- `category` - one of `products`, `guidelines`, `reports`, `uncategorized`, `non-browsable`
8687
- `date` - publication or last-updated date in ISO format
87-
- `product-name` - used internally for metadata and indexing
8888

8989
## Optional fields
9090

91+
- `type` - how the document is built. Leave it out for ordinary documents. Set `type: dashboard` for an interactive page: it renders to HTML only - no PDF, no table of contents, no version or changelog. New types are added by a Technical Library owner.
92+
- `product-name` - used internally for metadata and indexing
9193
- `template-version` - records which template version was used as the starting point. Set automatically when copying a template; don't edit it manually.
9294

9395
## System-managed fields

0 commit comments

Comments
 (0)