Contributing to this documentation

This GitBook is linked to the GitHub repository at https://github.com/jolie/docs.

The first step to update or create contents in the Jolie documentation is to fork the documentation repository.

Then, you can either update or create some content in your fork and, once done, you can issue a pull request to include your contribution in the official Jolie documentation.

Please check also the details in the rest of this page, below.

File structure

The location of the files follows the structure reported by the mdBook. For example, the page Compositing Statements is under path /web/language-tools-and-standard-library/basics/composing-statements/README.md/README.md.

Linking pages

It's advised to link pages using absolute links of the kind https://jolielang.gitbook.io/docs/your/page#and_anchor

Updating existing pages

To modify an existing page, it is sufficient to modify the related .md file.

In case you want to include new images in a page, we usually use (or create, in case it is missing) a dedicated sub-folder called img within the specific first-level sub-folder. For instance, if you want to add an image in a page under the documentation/basics sub-folder, you can create the img folder, save the image in it, and link it from the interested document.

We follow a similar structure also for archives (.zip) that contain comprehensive, runnable code examples, which are stored under the dedicated code folder.

Creating new pages

When creating a new page, please follow the guidelines above and make sure to:

• create the page as a new .md file, under one of the existing first-level sub-folders (or create a new one, if necessary);

• update the summary to show the link to the newly created page. This is done by editing the SUMMARY.md file, present in the root of the repository.