Skip to main content

Contributing

To the Language Server​

To contribute to the ELP language server, please refer to these instructions.

To the website​

The website is powered by Docusaurus. Most of the content is powered by Markdown.

You can find the source code under the website folder in the ELP repository. More detailed instructions on how to run the website locally are available here, but the short story is:

git clone https://github.com/WhatsApp/erlang-language-platform.git
cd erlang-language-platform/website
yarn install
yarn build
yarn start

The above will start a local server. You can start contributing content while watching live changes at:

http://localhost:3000

To the Erlang Error Index​

The Erlang Error Index is currently part of the ELP website, so you can refer to the instructions above on how to contribute content.

The entrypoint for the index is here.

Error codes are organized using namespaces, which are listed here. Generally speaking, a namespace corresponds to a tool which emits error codes (e.g. C for the Erlang Compiler). A folder is associated to each namespace. If the namespace is C, the corresponding folder is named c (lowered version of the namespace).

Under each folder you will see the following files:

  • _category_.json: Metadata for the namespace, such as a label and the relative position in the list of namespaces
  • about.md: High level introduction to the namespace (e.g. which tool is emitting codes for the given namespace)
  • A number of X1234.md files: A file for each error code emitted

You can find the list of emitted error codes here.

High-quality content contributions to the Error Index are extremely welcome!