Scilla short for Smart Contract Intermediate-Level LAnguage is a smart contract language being developed for Zilliqa.
If you spot any issues or have any ideas on how we can improve the documentation, help us log an issue here.
To compile the documentation you need the following system packages: Python3 with the pip package and libenchant used to check spelling.
On Debian-based systems you can install them with:
sudo apt-get install python3 python3-pip libenchant-2-dev
Then clone this repository and install the required Python packages from
requirements.txt:
pip3 -U install -r requirements.txt
Run make spell from docs folder. In case of any found spelling
mistakes you will see an output like the following:
Spelling checker messages written to /path/to/scilla-docs/docs/build/spelling/output.txt
WARNING: Found 1 misspelled words
Checkout the output.txt file and fix the typos.
If you need to teach the spelling checker more words, add them to the spelling_wordlist.txt file. The format is really simple -- it's just one word per line the file. And the file is sorted in ascending order.
Run make html from docs folder and make sure that the edits are
rendered correctly on the HTML files. To do that point your browser at the
locally built /path/to/scilla-docs/docs/build/html/index.html file and start
checking from it.
Please preview your HTML files before submitting a pull request. Try to squash your commits before making the pull request. We know it's difficult, but it helps us keep our commit logs clean and makes the reviewers' lives easier.