Skip to content

Commit 1c07ff9

Browse files
authored
Update Frontmatter Information
1 parent 2cfedbc commit 1c07ff9

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

src/meta/spec-for-specs.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ editors:
1515
affiliation:
1616
name: Protocol Labs
1717
url: https://protocol.ai/
18+
- name: Henrique Dias
19+
url: https://hacdias.com/
20+
github: hacdias
1821
xref:
1922
- dom
2023
- test-methodology
@@ -50,6 +53,8 @@ for this :ref[spec] looks like this:
5053

5154
```yaml
5255
---
56+
title: Specification Title
57+
description: A short description for this specification.
5358
date: 1977-03-15
5459
editors:
5560
- name: Robin Berjon
@@ -65,10 +70,15 @@ maturity: stable
6570
xref:
6671
- dom
6772
- test-methodology
73+
tags: ['meta']
74+
order: 0
6875
---
6976
```
7077

71-
The :ref[frontmatter] MUST contain an `editors` field, which is an array of objects describing people
78+
The :ref[frontmatter] MUST contain a `title` field, which is the title of the specification. In addition,
79+
it SHOULD include a `description` field with the description of the specification.
80+
81+
The :ref[frontmatter] MUST also contain an `editors` field, which is an array of objects describing people
7282
who are responsible for editing this given :ref[spec]. The `editors` field MUST contain at least one
7383
person. The fields that describe a person are `name`, `email`, `url`, `github`, `twitter`, `mastodon`,
7484
and `affiliation` which is in turn an object with fields `name` and `url`. Each person as well as the
@@ -87,6 +97,14 @@ maturity levels currently supported are:
8797

8898
The `date` field is a `YYYY-MM-DD` specification of the last dated change to the spec.
8999

100+
The `tags` field is an array with strings that indicate which group of specifications this particular
101+
specification is part of. For example, the specification you are currently reading, Specs for Specs,
102+
is part of the "meta" group of specifications.
103+
104+
The `order` field is a numeric field that includes the order by which the specification will be displayed
105+
in the lists of specifications in the homepage and group pages. For this, `0` is the highest order, and `999`
106+
is the default value.
107+
90108
### Title & Sections
91109

92110
A :ref[spec] MUST have a title, which is to say an `h1` heading (`title` field in the :ref[frontmatter]). It

0 commit comments

Comments
 (0)