|
22 | 22 | The simplest thing to do is create a new file in this repository,
|
23 | 23 | `message-index/messages/GHC-00000/index.md`, and write your documentation there.
|
24 | 24 |
|
25 |
| -Here is a template you can use for the file: |
26 |
| -[FIXME: providing a tool would be a lot nicer] |
| 25 | +Here is a template you can use for the file [FIXME: use the tool provided by #408 when available.]: |
27 | 26 |
|
28 | 27 | ```
|
29 | 28 | ---
|
30 |
| -title: [FIXME: Is this something written by the contributor, or does it come from the tool?] |
31 |
| -summary: [FIXME: Is this something written by the contributor, or does it come from the tool?] |
32 |
| -severity: [FIXME]: What are the possible values here? |
33 |
| -introduced: <!-- Optional, but good to add if you know when the message was added to the tool --> |
34 |
| -flag: <!-- Optional. Is there a flag that enables this message? --> |
| 29 | +title: <Your title for the message> |
| 30 | +summary: <Your short summary, as a sentence.> |
| 31 | +severity: <!-- Optional. one of `error` or `warning`. --> |
| 32 | +introduced: <!-- Optional. Represents when the **code** for this message was added to the tool --> |
| 33 | +flag: <!-- Optional. If it exists, list the tool's flag that enables this message --> |
35 | 34 | ---
|
36 | 35 |
|
37 |
| -YOUR DESCRIPTION GOES HERE |
| 36 | +<Your description> |
38 | 37 | ```
|
39 | 38 |
|
40 | 39 | You can look at other messages in the Index to get a feel for the documentation style used in
|
41 | 40 | this project.
|
42 | 41 |
|
43 |
| -To explore the full range of documentation possibilities, see [Reference: The Anatomy of a Message] below. |
| 42 | +To explore the full range of documentation possibilities, see [The Anatomy of a |
| 43 | +Message][anatomy] below. It explains each of the fields in the header above, and includes |
| 44 | +another example document for reference. |
| 45 | + |
| 46 | +[anatomy]: #reference-the-anatomy-of-a-message |
44 | 47 |
|
45 | 48 | ## If You *Don't* Know Which Message You Want to Document
|
46 | 49 |
|
|
0 commit comments