Commit 224059d8 authored by Camil Staps's avatar Camil Staps 🚀

Update documentation

parent 193c2336
......@@ -68,6 +68,18 @@ We will take immediate action.
If the library is not well-known it is advised to first open an issue to see
whether it is suitable to be indexed by cloogle.
### Preparation
Your library will be most easily accessible when:
- Functions, type definitions, classes and modules are documented. For details
on the documentation format, see
[DOCUMENTATION.md](https://gitlab.science.ru.nl/clean-and-itasks/clean-platform/blob/master/doc/DOCUMENTATION.md)
in Platform.
- Macros have types using the `@type` documentation field.
Having documentation is not a strict requirement, however.
### Updating the index
To add a library you have to modify [`libs.json`](/libs.json). This file is a
JSON record with three collections of Clean libraries. Usually, you should add
the new library to the `Miscellaneous` collection. Please keep the alphabetic
......
......@@ -17,7 +17,7 @@ find usages.
- [Frontends](#frontends)
- [Auxiliary tools](#auxiliary-tools)
- [Interfacing with Cloogle](#interfacing-with-cloogle)
- [Preparing a library for indexing](#preparing-a-library-for-indexing)
- [Adding a library to the index](#adding-a-library-to-the-index)
- [Local setup](#local-setup)
- [Authors, copyright & license](#authors-copyright--license)
......@@ -94,17 +94,8 @@ These error messages are indexed by the frontend rather than the backend.
Additionally, the HTTP API may give return codes above 150, which are not used
by the TCP API. For the meaning of the return codes, see [Cloogle.API (icl)][].
## Preparing a library for indexing
Your library will be most easily accessible when:
- Functions, type definitions, classes and modules are documented. For details
on the documentation format, see the README of the [Cloogle][] submodule.
- Macros have types using the `@type` documentation field.
Having documentation is not a strict requirement, however.
To add your library to the index, follow the steps in
[CONTRIBUTING.md](/CONTRIBUTING.md#3-i-just-want-to-add-library-x) and create a
pull request.
## Adding a library to the index
See [CONTRIBUTING.md](/CONTRIBUTING.md#3-i-just-want-to-add-library-x).
## Local setup
After installing [docker-compose][] run the following commands:
......
Subproject commit dffef780dc70c0611d73e3eeacc0f04ac4b63619
Subproject commit 363368badb0b2a2609ab1ea54fd16aba8fe55e68
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment