This is the official repository for The Open Network documentation.
Latest documentation release: docs.ton.org
The mission of this documentation is to collect all available information and knowledge that can help TON developers.
You can improve the documentation by following steps below.
TON is an actively growing ecosystem, and every day many devs contribute to its development.
You can participate in TON by helping organize knowledge, making Pull Requests and creating tutorials to help other developers. Feedback, lectures, technical articles, tutorials, and examples. All this can help the developers community grow even faster!
Join TON Docs Club chat in Telegram to join contributors party:
If you are a developer and faced some difficulties, successfully overcoming them - share this knowledge with future developers!
— Have an issue? Prepare a solution with TON Docs Wizard.
— Have an idea? Submit a Feature Request.
— Want to contribute? Setup your environment.
Contributing best practices: docs/contribute
If you are changing the sidebar or adding media-files, please check that your submission will not break production.
You can do this in two ways:
Use Gitpod (a free, online VS code-like IDE) for contributing. It will launch a workspace with a single click:
-
Download repository from GitHub with its submodules
git clone --recursive https://github.com/ton-community/ton-docs.git -
Install last version NodeJS LTS to run local build
-
Open Terminal in project directory
-
Install dependencies with command:
npm install -
Run project with command:
npm run start -
Build with multiple locales and run it locally
npm run build npm run serve
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.