/ton-docs

User-friendly documentation for newcomers to the TON blockchain.

Primary LanguageCSSGNU General Public License v3.0GPL-3.0

TON Blockchain Documentation 📚

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.


Join TON Docs Club 💎

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 and get the latest tasks from maintainers:


How to Contribute? 🦄

As said before, it's up to you.

If you are a developer and faced some difficulties, successfully overcoming them - share this knowledge with future developers!

— Have an idea? Submit an issue.
— Want to validate changes? Setup your environment.

Contributing best practices: docs/contribute


Set up your Environment ☁️

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:

Cloud (quick way)

Use Gitpod (a free, online VS code-like IDE) for contributing. It will launch a workspace with a single click:

Open in Gitpod

Local (default way)

  1. Download repository from GitHub

  2. Install last version NodeJS LTS to run local build

  3. Open Terminal in project directory

  4. Install dependencies with command:

    npm install
    
  5. Run project with command:

    npm run start
    

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

License

GPL-3.0