Skip to content

Commit 1ba1748

Browse files
Improve contributor documentation
1 parent eb1d2cd commit 1ba1748

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ The message index is in the directory `message-index`.
99

1010
## Building GHC with Error Codes
1111

12-
Please follow the instructions on [building GHC with Hadrian](https://gitlab.haskell.org/ghc/ghc/-/wikis/building/hadrian), using a version of the `master` branch from after 13 September, 2022 or a release of version 9.6.1 or higher.
13-
Your error messages would then contain an ID.
12+
Until the release of GHC 9.6.1, error and warning IDs are only available using a development version of GHC. Please
13+
follow the instructions on [building GHC with Hadrian](https://gitlab.haskell.org/ghc/ghc/-/wikis/building/hadrian),
14+
using a version of the `master` branch from after 13 September, 2022. Your error messages would then contain an ID:
1415

1516
```
1617
$ _build/stage1/bin/ghc --interactive

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# The Haskell Message Index
22
[![.github/workflows/deploy.yml](https://github.com/haskellfoundation/error-message-index/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/haskellfoundation/error-message-index/actions/workflows/deploy.yml)
33

4-
Haskell tooling emits a variety of errors, warnings, and other messages. In an unreleased branch, GHC emits a unique code for each message that allows it to be identified. This site allows these codes to be looked up, providing examples, context, and further information that can make them easier to understand.
4+
Haskell tooling emits a variety of errors, warnings, and other messages. In the latest development versions that are leading to the release of version 9.6.1, GHC emits a unique code for each message that allows it to be identified. This site allows these codes to be looked up, providing examples, context, and further information that can make them easier to understand.
55

66
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on improving the site. Thanks!
77

tech-choices.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,13 @@
22

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

5-
- [highlight.js](https://highlightjs.org/) for highlighting blocks of code. [License: BSD 3-Clause](https://github.com/highlightjs/highlight.js/blob/main/LICENSE).
6-
- [TableFilter](http://www.tablefilter.com/) for the filtering functionality in the error message table. [License: MIT](https://github.com/koalyptus/TableFilter/blob/master/LICENSE).
5+
- [highlight.js](https://highlightjs.org/) for highlighting blocks of code. [License: BSD 3-Clause](https://github.com/highlightjs/highlight.js/blob/main/LICENSE).
6+
- [TableFilter](http://www.tablefilter.com/) for the filtering functionality in the error message table. [License: MIT](https://github.com/koalyptus/TableFilter/blob/master/LICENSE).
7+
8+
Generally speaking, we choose technology for this site based on the following criteria:
9+
10+
* The build process for the site should be simple, relying on no build tools or package managers aside from `cabal` or `stack`
11+
* CSS and Javascript code should be straightforward to maintain by someone who has only rudimentary front-end development skills
12+
* The generated site should consist only of static files that can be hosted anywhere
13+
* URLs should be predictable, and easy for external tools to generate (e.g. so IDEs can link to error documentation)
14+

0 commit comments

Comments
 (0)