🚀 First beta release of the new TON documentation https://beta-docs.ton.org/!
🗺 https://beta-docs.ton.org/ or stay here to learn about the project's backstory, current achievements, and future plans.
For quite some time, developers shared the same feedback: TON documentation is too scattered, difficult to navigate, and has obvious gaps and inconsistencies.
We at TON Studio took that seriously and initiated the TON Docs Revamp project in late July. It is focused on the following four goals:
• To introduce a streamlined, discoverable structure that would be easy to navigate and search
• To make documentation welcoming to all developers, from newcomers to seasoned professionals
• To introduce and maintain stricter quality checks from humans and AIs to ensure proof-read, up-to-date, consistent, and clear content
• And, finally, to set up documentation release pipelines for major TON builders, while making community contributions straightforward and approachable
🏆 Today, with the help and suggestions from various developer teams, including Zengo, RSquad, TonTech, TON API team, and TON Core, the TON Studio is proud to present the first public version of this documentation. It already fulfills the first goal of comprehensive structure and rapidly moves towards achieving the third goal of content.
🦄 That said, this is a beta release: many pages await their contents, some pages require secondary reviews, while infrastructure, pipelines, and processes are only nourishing, not mature yet. https://github.com/ton-org/docs/issues.
So, what's in store already? We've got:
• Flat, easy-to-navigate structure
• Hands-on articles with real examples whenever we can provide them
• Visuals and diagrams, including various Mermaid diagrams
• Smart AI search and summaries
• Automatic CI spell checks and AI reviews based on the growing style guide
• ...and much, much more!
🏠 TON Docs Revamp features an engaging landing page that guides users through their TON journey, whether they're first exploring TON, building smart contracts, integrating wallets, or just want to access and navigate the documentation quickly.
📝 Re-written or brand new content includes pages for: mytonctrl, mylocalton, development setups with Sandbox and Blueprint (with major help from TonTech), IDEs and SDKs, gas estimation, analytics, oracles, bridges, TMAs, TON Connect, standard wallet contracts, Jettons, NFTs, TVM instructions (with proper search and discovery), TL-B, FunC and other TON-specific programming languages, web versions of whitepapers (with cross-links and solid AI summaries), and even a "Coming from Ethereum" guide!
📈 And this is just the beginning. Plans ahead and for the next month include:
- Release pipelines and assignments of relevant technical owners
- Docs, infrastructure, and processes for approachable community contributions
- More playgrounds, interactive components, and interactivity
- Much more content
- Stronger AI-based assistance as documentation grows
🎯 The main goals of this beta release are to show preliminary progress, willingness to make things right, and to collect feedback from the developer community before the full release, which is tentatively scheduled for November 17th.
We are nothing without the feedback from the community. If something is missing or confusing, let us know by https://github.com/ton-org/docs/issues. Furthermore, help review new content whenever you or someone you know is deeply familiar with the topic. TON is vast, and there is always something to know or be aware of.
Prominent ecosystem projects are invited to host, co-own, and maintain their documentation with us. Keeping things in one place will enrich the user experience and AI responses.
💪 Let's make the best documentation for TON. Together.
→ Beta release URL: http://beta-docs.ton.org/
→ GitHub repository: http://github.com/ton-org/docs
→ Future milestones: http://github.com/ton-org/docs/milestone/3
