Skip to content

Commit 2e8e4e9

Browse files
committed
Rename reference section to clarify its purpose
1 parent 8922ef8 commit 2e8e4e9

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
@@ -71,10 +71,13 @@ using a bunch of issues:
7171
- Issues related to improving the site, the workflow for contributing, or other information are tagged `error-message-index-site`: https://github.com/haskellfoundation/error-message-index/labels/error-message-index-site
7272
- Issues related to improving, clarifying, or extending existing documentation are tagged `error-message-index-improvements`: https://github.com/haskellfoundation/error-message-index/labels/error-message-index-improvements
7373

74-
## Contributing New Messages
74+
## Reference: The Anatomy of a Message
7575

7676
The Haskell Message Index is generated from a collection of files on
77-
disk using Hakyll. Inside the top-level of the site source, there is a
77+
disk using Hakyll. From these files, descriptions of the message are generated,
78+
as well as examples of how to handle them.
79+
80+
Inside the top-level of the site source, there is a
7881
`messages` directory. Within `messages`, each subdirectory represents
7982
a message whose name is the message code. This subdirectory contains a
8083
file `index.md` that describes the message. Additionally,
@@ -101,6 +104,8 @@ named as specified here, while the other components may vary.
101104

102105
You can also use the `makeFolder.sh` templating script. Usage is as follows:
103106

107+
[FIXME: makeFolder.sh is GHC-specific]
108+
104109
```bash
105110
./makeFolder.sh <NAMESPACE>-<NUMERIC_ERROR_CODE> <HaskellModuleName>
106111
```

0 commit comments

Comments
 (0)