iExec Tools documentation

This is the source repository of the iExec tools documentation rendered by gitbook.

• production branch is rendered at https://tools.docs.iex.ec
• staging branch is rendered at https://documentations.iex.ec/iexec-tools-staging

To keep the contribution process smooth, please read this small guide.

Fork the staging branch

Apply your changes on your forked branch, stage them and commit them with a descriptive commit message.

Push your changes to your forked branch.

Tips:
The space root is ./documentation/
The first page is ./documentation/README.md
The summary is ./documentation/SUMMARY.md

Open a Pull-Request from your forked branch to the staging branch.

A preview of your changes will be rendered on the staging environment.

Click on the "Details" link to access the preview.

Tips:
You can open a draft Pull-Request and set it "Ready for review" when you are happy with the preview.

Open Pull-Request will be reviewed by the team and merged once approved.

After a short while the team will merge the staging branch into the production branch and your changes will be live on tools.docs.iex.ec.