File tree Expand file tree Collapse file tree 1 file changed +7
-2
lines changed Expand file tree Collapse file tree 1 file changed +7
-2
lines changed Original file line number Diff line number Diff line change @@ -170,11 +170,16 @@ The fields in the metadata block should be:
170
170
### Example Descriptions
171
171
172
172
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
175
175
example. The ` index.md ` file should explain how the files illustrate
176
176
the message.
177
177
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
+
178
183
## Reference: Technology choices
179
184
180
185
The website generated by ` message-index ` uses a few JS components.
You can’t perform that action at this time.
0 commit comments