{"id":18437873,"url":"https://github.com/zilliqa/scilla-docs","last_synced_at":"2025-08-04T23:20:47.721Z","repository":{"id":44734852,"uuid":"137974450","full_name":"Zilliqa/scilla-docs","owner":"Zilliqa","description":"Documentation for Scilla","archived":false,"fork":false,"pushed_at":"2023-01-30T20:14:19.000Z","size":1345,"stargazers_count":17,"open_issues_count":40,"forks_count":16,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-14T13:14:29.831Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://scilla.readthedocs.io","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-20T03:17:31.000Z","updated_at":"2023-09-18T23:33:23.000Z","dependencies_parsed_at":"2023-02-16T11:16:00.132Z","dependency_job_id":null,"html_url":"https://github.com/Zilliqa/scilla-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fscilla-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fscilla-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fscilla-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fscilla-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/scilla-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886342,"owners_count":21177645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:30.469Z","updated_at":"2025-04-14T13:14:34.085Z","avatar_url":"https://github.com/Zilliqa.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scilla Docs\n\n![](https://github.com/Zilliqa/scilla-docs/workflows/build/badge.svg)\n\nScilla short for Smart Contract Intermediate-Level LAnguage is a smart contract\nlanguage being developed for Zilliqa.\n\n## Contributing\n\nIf you spot any issues or have any ideas on how we can improve the\ndocumentation, help us log an issue\n[here](https://github.com/Zilliqa/scilla-docs/issues).\n\n## Installing dependencies\n\nTo compile the documentation you need the following system packages:\n[Python3](https://www.python.org/downloads/) with the\n[pip](https://pypi.org/project/pip/) package and\n[libenchant](https://www.abisource.com/projects/enchant/) used to check\nspelling.\n\nOn Debian-based systems you can install them with:\n```\nsudo apt-get install python3 python3-pip libenchant-2-dev\n```\n\nThen clone this repository and install the required Python packages from\n[`requirements.txt`](https://github.com/Zilliqa/scilla-docs/blob/master/requirements.txt):\n```\npip3 -U install -r requirements.txt\n```\n\n## Building the docs\n\n### Spellchecking\n\nRun `make spell` from [docs](./docs/) folder. In case of any found spelling\nmistakes you will see an output like the following:\n```\nSpelling checker messages written to /path/to/scilla-docs/docs/build/spelling/output.txt\nWARNING: Found 1 misspelled words\n```\nCheckout the `output.txt` file and fix the typos.\n\nIf you need to teach the spelling checker more words, add them to the\n[spelling_wordlist.txt](./docs/source/spelling_wordlist.txt) file. The format is\nreally simple -- it's just one word per line the file. And the file is sorted in\nascending order.\n\n### Building HTML docs\n\nRun `make html` from [docs](./docs/) folder and make sure that the edits are\nrendered correctly on the HTML files. To do that point your browser at the\nlocally built `/path/to/scilla-docs/docs/build/html/index.html` file and start\nchecking from it.\n\n### Before submitting a pull request\n\nPlease preview your HTML files _before_ submitting a pull request. Try to\n[squash](https://blog.github.com/2016-04-01-squash-your-commits/) your commits\nbefore making the pull request. We know it's difficult, but it helps us keep our\ncommit logs clean and makes the reviewers' lives easier.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fscilla-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fscilla-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fscilla-docs/lists"}