Skip to content

Commit 9a4f364

Browse files
Document the 'order' field
1 parent 4c8e1d8 commit 9a4f364

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,11 +170,16 @@ The fields in the metadata block should be:
170170
### Example Descriptions
171171

172172
Example descriptions are written in Markdown with Pandoc-style
173-
metadata, just like message descriptions. They have only the `title`
174-
field. All `.hs` files are shown in the list of files for the
173+
metadata, just like message descriptions. They have the obligatory `title`
174+
and optional `order` fields. All `.hs` files are shown in the list of files for the
175175
example. The `index.md` file should explain how the files illustrate
176176
the message.
177177

178+
Examples are ordered according to their `order` field. Examples
179+
with no explicit `order` are shown last and examples with the same
180+
`order` will be shown in an unspecified order with respect to each other,
181+
but will appear before examples with a greater order.
182+
178183
## Reference: Technology choices
179184

180185
The website generated by `message-index` uses a few JS components.

0 commit comments

Comments
 (0)