+
# Welcome to ⚡ Tact Documentation
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
index 0ab2f48b2..49e4100ea 100644
--- a/docs/astro.config.mjs
+++ b/docs/astro.config.mjs
@@ -45,9 +45,9 @@ export default defineConfig({
starlight({
title: {
en: '⚡ Tact Documentation',
- 'zh-CN': '⚡ Tact Documentation',
+ 'zh-CN': '⚡ Tact 语言文档',
},
- titleDelimiter: '-',
+ titleDelimiter: undefined,
favicon: '/favicon.png',
logo: {
dark: '/public/logo-dark.svg',
@@ -55,7 +55,7 @@ export default defineConfig({
alt: '⚡ Tact Documentation',
replacesTitle: true,
},
- // 'head' is auto-populated with SEO-friendly contents
+ // 'head' is auto-populated with SEO-friendly contents based on the page frontmatters
social: {
github: 'https://github.com/tact-lang/tact',
telegram: 'https://t.me/tactlang',
@@ -113,7 +113,7 @@ export default defineConfig({
'zh-CN': '图书',
},
items: [
- 'book',
+ { slug: 'book' },
{
label: 'Cheatsheets',
translations: {
@@ -123,52 +123,52 @@ export default defineConfig({
autogenerate: { directory: 'book/cs' },
},
{
- label: 'Fundamentals of Tact',
- translations: { 'zn-CN': 'Tact 语言基础' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Fundamentals of Tact',
+ translations: { 'zh-CN': 'Tact 语言基础' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'book/types',
- 'book/integers',
- 'book/cells',
- 'book/maps',
- 'book/structs-and-messages',
- 'book/optionals',
- 'book/contracts',
- 'book/exit-codes',
+ { slug: 'book/types' },
+ { slug: 'book/integers' },
+ { slug: 'book/cells' },
+ { slug: 'book/maps' },
+ { slug: 'book/structs-and-messages' },
+ { slug: 'book/optionals' },
+ { slug: 'book/contracts' },
+ { slug: 'book/exit-codes' },
{
- label: 'Expressiveness',
- translations: { 'zn-CN': '表现力' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Expressiveness',
+ translations: { 'zh-CN': '表现力' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'book/operators',
- 'book/expressions',
- 'book/statements',
- 'book/constants',
- 'book/functions',
+ { slug: 'book/operators' },
+ { slug: 'book/expressions' },
+ { slug: 'book/statements' },
+ { slug: 'book/constants' },
+ { slug: 'book/functions' },
{
- label: 'Communication',
- translations: { 'zn-CN': '交流' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Communication',
+ translations: { 'zh-CN': '交流' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'book/receive',
- 'book/bounced',
- 'book/external',
- 'book/lifecycle',
- 'book/send',
- 'book/message-mode',
+ { slug: 'book/receive' },
+ { slug: 'book/bounced' },
+ { slug: 'book/external' },
+ { slug: 'book/lifecycle' },
+ { slug: 'book/send' },
+ { slug: 'book/message-mode' },
{
- label: 'Going places',
- translations: { 'zn-CN': '前往各地' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Going places',
+ translations: { 'zh-CN': '前往各地' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'book/deploy',
- 'book/debug',
- 'book/upgrades',
- 'book/import',
- 'book/config',
- 'book/masterchain',
- 'book/func',
- 'book/programmatic',
+ { slug: 'book/deploy' },
+ { slug: 'book/debug' },
+ { slug: 'book/upgrades' },
+ { slug: 'book/import' },
+ { slug: 'book/config' },
+ { slug: 'book/masterchain' },
+ { slug: 'book/func' },
+ { slug: 'book/programmatic' },
],
},
{
@@ -177,28 +177,28 @@ export default defineConfig({
'zh-CN': '食谱',
},
items: [
- 'cookbook',
+ { slug: 'cookbook' },
{
- label: 'Single contract',
- translations: { 'zn-CN': '单一合同' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Single contract',
+ translations: { 'zh-CN': '单一合同' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'cookbook/single-communication',
- 'cookbook/type-conversion',
- 'cookbook/data-structures',
- 'cookbook/algo',
- 'cookbook/time',
- 'cookbook/access',
- 'cookbook/random',
- 'cookbook/misc',
+ { slug: 'cookbook/single-communication' },
+ { slug: 'cookbook/type-conversion' },
+ { slug: 'cookbook/data-structures' },
+ { slug: 'cookbook/algo' },
+ { slug: 'cookbook/time' },
+ { slug: 'cookbook/access' },
+ { slug: 'cookbook/random' },
+ { slug: 'cookbook/misc' },
{
- label: 'Multiple contracts',
- translations: { 'zn-CN': '多重合同' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Multiple contracts',
+ translations: { 'zh-CN': '多重合同' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'cookbook/multi-communication',
- 'cookbook/jettons',
- 'cookbook/nfts',
+ { slug: 'cookbook/multi-communication' },
+ { slug: 'cookbook/jettons' },
+ { slug: 'cookbook/nfts' },
{
label: 'Decentralized EXchanges (DEXes)',
translations: {
@@ -215,8 +215,8 @@ export default defineConfig({
'zh-CN': '参考',
},
items: [
- 'ref',
- 'ref/spec',
+ { slug: 'ref' },
+ { slug: 'ref/spec' },
{
'label': 'Evolution',
translations: {
@@ -226,31 +226,31 @@ export default defineConfig({
autogenerate: { directory: 'ref/evolution' }
},
{
- label: 'Core library',
- translations: { 'zn-CN': '核心图书馆' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Core library',
+ translations: { 'zh-CN': '核心图书馆' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'ref/core-base',
- 'ref/core-common',
- 'ref/core-comptime',
- 'ref/core-debug',
- 'ref/core-random',
- 'ref/core-math',
- 'ref/core-strings',
- 'ref/core-cells',
- 'ref/core-advanced',
+ { slug: 'ref/core-base' },
+ { slug: 'ref/core-common' },
+ { slug: 'ref/core-comptime' },
+ { slug: 'ref/core-debug' },
+ { slug: 'ref/core-random' },
+ { slug: 'ref/core-math' },
+ { slug: 'ref/core-strings' },
+ { slug: 'ref/core-cells' },
+ { slug: 'ref/core-advanced' },
{
- label: 'Standard libraries',
- translations: { 'zn-CN': '标准图书馆' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Standard libraries',
+ translations: { 'zh-CN': '标准图书馆' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'ref/standard-libraries',
- 'ref/stdlib-config',
- 'ref/stdlib-content',
- 'ref/stdlib-deploy',
- 'ref/stdlib-dns',
- 'ref/stdlib-ownable',
- 'ref/stdlib-stoppable',
+ { slug: 'ref/standard-libraries' },
+ { slug: 'ref/stdlib-config' },
+ { slug: 'ref/stdlib-content' },
+ { slug: 'ref/stdlib-deploy' },
+ { slug: 'ref/stdlib-dns' },
+ { slug: 'ref/stdlib-ownable' },
+ { slug: 'ref/stdlib-stoppable' },
],
},
{
@@ -259,16 +259,16 @@ export default defineConfig({
'zh-CN': '生态系统',
},
items: [
- 'ecosystem',
+ { slug: 'ecosystem' },
{
- label: 'Tools',
- translations: { 'zn-CN': '工具' },
- link: '#', attrs: { class: 'sidebar-separator' }
+ label: 'Tools',
+ translations: { 'zh-CN': '工具' },
+ link: '#', attrs: { class: 'sidebar-separator' }
},
- 'ecosystem/typescript',
- 'ecosystem/vscode',
- 'ecosystem/jetbrains',
- 'ecosystem/misti',
+ { slug: 'ecosystem/typescript' },
+ { slug: 'ecosystem/vscode' },
+ { slug: 'ecosystem/jetbrains' },
+ { slug: 'ecosystem/misti' },
],
},
{
diff --git a/docs/inline-code-highlighting.js b/docs/inline-code-highlighting.js
index 9013a817a..eab2324a5 100644
--- a/docs/inline-code-highlighting.js
+++ b/docs/inline-code-highlighting.js
@@ -9,8 +9,8 @@ import { toString } from 'hast-util-to-string';
import {
bundledLanguages,
createHighlighter,
- createWasmOnigEngine,
} from 'shiki';
+import { createOnigurumaEngine } from 'shiki/engine/oniguruma';
import fs from 'node:fs';
// Import custom grammars
@@ -71,7 +71,7 @@ export default function rehypeInlineCodeHighlighting() {
],
// TODO: Made the 'name' lowercase in the TextMate grammars
langAlias: { fc: 'func' },
- engine: await createWasmOnigEngine(import('shiki/wasm')),
+ engine: await createOnigurumaEngine(import('shiki/wasm')),
});
// Apply highlighting to each target node
diff --git a/docs/src/content/docs/book/bounced.mdx b/docs/src/content/docs/book/bounced.mdx
index 4be704fab..e44421850 100644
--- a/docs/src/content/docs/book/bounced.mdx
+++ b/docs/src/content/docs/book/bounced.mdx
@@ -1,5 +1,6 @@
---
title: Bounced messages
+description: "When a contract sends a message with a flag bounce set to true, then if the message wasn't processed properly, it would bounce back to the sender"
---
When a contract sends a message with a flag `bounce` set to `true{:tact}`, then if the message wasn't processed properly, it would bounce back to the sender. This is useful when you want to make sure that the message was processed properly and if not — revert the changes.
diff --git a/docs/src/content/docs/book/cells.mdx b/docs/src/content/docs/book/cells.mdx
index 3e39134ca..621c8e36d 100644
--- a/docs/src/content/docs/book/cells.mdx
+++ b/docs/src/content/docs/book/cells.mdx
@@ -1,5 +1,6 @@
---
title: Cells, Builders and Slices
+description: "Cells, Builders and Slices are low-level primitives of TON Blockchain"
---
[Cells](#cells), [Builders](#builders) and [Slices](#slices) are low-level [primitives][p] of TON Blockchain. The virtual machine of TON Blockchain, [TVM][tvm], uses cells to represent all data structures in persistent storage, and most in memory.
diff --git a/docs/src/content/docs/book/config.mdx b/docs/src/content/docs/book/config.mdx
index 10e8a838d..edd070293 100644
--- a/docs/src/content/docs/book/config.mdx
+++ b/docs/src/content/docs/book/config.mdx
@@ -1,10 +1,11 @@
---
title: Configuration
+description: "The behavior of Tact compiler can be customized using its configuration file"
---
The behavior of Tact compiler can be customized using its configuration file, `tact.config.json` — a JSON file that contains the list of settings according to the specific [schema](#schema).
-This page lists all of the configuration options as they're structured in the [schema](#schema). Look for table of contents on the right to easily navigate them.
+This page lists all the configuration options as they're structured in the [schema](#schema). Look for table of contents on the right to easily navigate them.
:::note
diff --git a/docs/src/content/docs/book/constants.mdx b/docs/src/content/docs/book/constants.mdx
index 24ec3480b..f63129f26 100644
--- a/docs/src/content/docs/book/constants.mdx
+++ b/docs/src/content/docs/book/constants.mdx
@@ -1,8 +1,9 @@
---
title: Constants
+description: "Immutable values that cannot be changed through reassignment"
---
-Constants in Tact could be a little bit more advanced than in popular languages: they could be virtual and abstract. Smart contracts often need to implement multiple traits and sometimes you need to configure some of them in compile time. Constructors in traits are prohibited due to their unpredicted behavior. So, we have to use constants and fields instead to pass values to them. It is the job of a main contract to implement values and constants for all traits.
+Constants in Tact could be a little bit more advanced than in popular languages: they could be virtual and abstract. Smart contracts often need to implement multiple traits and sometimes you need to configure some of them in compile time. Constructors in traits are prohibited due to their unpredictable behavior. So, we have to use constants and fields instead to pass values to them. It is the job of a main contract to implement values and constants for all traits.
## Simple constant
diff --git a/docs/src/content/docs/book/contracts.mdx b/docs/src/content/docs/book/contracts.mdx
index d3dd21e3a..caf2eb503 100644
--- a/docs/src/content/docs/book/contracts.mdx
+++ b/docs/src/content/docs/book/contracts.mdx
@@ -1,5 +1,6 @@
---
title: Contracts
+description: "Contracts in Tact are similar to classes in popular object-oriented languages, except that their instances are deployed on the blockchain and they can't be passed around like Structs and Messages"
---
Contracts in Tact are similar to classes in popular object-oriented languages, except that their instances are deployed on the blockchain and they can't be passed around like [Structs and Messages](/book/structs-and-messages).
diff --git a/docs/src/content/docs/book/cs/from-func.mdx b/docs/src/content/docs/book/cs/from-func.mdx
index aff5a269a..01e3e6758 100644
--- a/docs/src/content/docs/book/cs/from-func.mdx
+++ b/docs/src/content/docs/book/cs/from-func.mdx
@@ -1,5 +1,6 @@
---
title: Coming from FunC
+description: "A cheat sheet to quickly transition from FunC to Tact"
sidebar:
order: 1
---
diff --git a/docs/src/content/docs/book/cs/from-solidity.mdx b/docs/src/content/docs/book/cs/from-solidity.mdx
index 30798de2a..bc4f46715 100644
--- a/docs/src/content/docs/book/cs/from-solidity.mdx
+++ b/docs/src/content/docs/book/cs/from-solidity.mdx
@@ -1,5 +1,6 @@
---
title: Coming from Solidity
+description: "A cheat sheet to quickly transition from Solidity to Tact and from Ethereum to TON Blockchain"
sidebar:
order: 2
---
diff --git a/docs/src/content/docs/book/debug.mdx b/docs/src/content/docs/book/debug.mdx
index ec922de34..a3305ec88 100644
--- a/docs/src/content/docs/book/debug.mdx
+++ b/docs/src/content/docs/book/debug.mdx
@@ -1,5 +1,6 @@
---
title: Debugging Tact contracts
+description: "Various ways to reveal problems or bugs in Tact code"
---
import { LinkCard, CardGrid, Steps, Tabs, TabItem } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/book/deploy.mdx b/docs/src/content/docs/book/deploy.mdx
index 9702a5a54..23c0573e6 100644
--- a/docs/src/content/docs/book/deploy.mdx
+++ b/docs/src/content/docs/book/deploy.mdx
@@ -1,5 +1,6 @@
---
title: Deployment
+description: "Common ways to deploy Tact contracts to testnet or mainnet of TON Blockchain"
---
Tact Deployer is a small library that integrates with [TON Verifier](https://verifier.ton.org) that allows you to deploy your contracts safely using your favorite wallet without needing to manage keys or deploy contracts manually. Tact Deployer also automatically verifies your contract's source code and you can be sure that your compiler is not compromised.
diff --git a/docs/src/content/docs/book/exit-codes.mdx b/docs/src/content/docs/book/exit-codes.mdx
index 42a46e20c..dc5c78744 100644
--- a/docs/src/content/docs/book/exit-codes.mdx
+++ b/docs/src/content/docs/book/exit-codes.mdx
@@ -1,5 +1,6 @@
---
-title: Exit Codes
+title: Exit codes
+description: "An exit code is a 32-bit signed integer, which indicates whether the compute or action phase of the transaction was successful, and if not — signals the code of the exception occurred"
---
:::caution
diff --git a/docs/src/content/docs/book/expressions.mdx b/docs/src/content/docs/book/expressions.mdx
index 9ff8f5012..e60f38058 100644
--- a/docs/src/content/docs/book/expressions.mdx
+++ b/docs/src/content/docs/book/expressions.mdx
@@ -1,5 +1,6 @@
---
title: Expressions
+description: "This page lists all the expressions in Tact"
---
Every operator in Tact forms an expression, but there's much more to uncover as Tact offers a wide range of expressive options to choose from.
diff --git a/docs/src/content/docs/book/external.mdx b/docs/src/content/docs/book/external.mdx
index b16385e7d..ed545f610 100644
--- a/docs/src/content/docs/book/external.mdx
+++ b/docs/src/content/docs/book/external.mdx
@@ -1,7 +1,12 @@
---
title: External Messages
+description: "External messages don't have a sender and can be sent by anyone from the offchain"
---
+:::caution
+ This page is under re-construction as per [#384](https://github.com/tact-lang/tact-docs/issues/384). All anchor links (`#`) may change in the future!
+:::
+
:::caution
External message support must be enabled explicitly in the project configuration.
Without enabling it compilation would fail.
@@ -26,13 +31,15 @@ External messages are not accepted automatically. You need to accept them manual
10k gas is a very small limit, and Tact itself can consume a sizable amount of gas before it even reaches your code. You should always test the gas usage of your contracts and verify that everything is working as intended.
:::tip[Hey there!]
+
The 10k gas limit for external messages is based on the parameter we set by the
validator for the whole blockchain of the `gas_limit` field. You can take
the reference here:
- - https://docs.ton.org/develop/smart-contracts/guidelines/accept#external-messages
- - https://docs.ton.org/develop/howto/blockchain-configs#param-20-and-21
- :::
+ - https://docs.ton.org/develop/smart-contracts/guidelines/accept#external-messages
+ - https://docs.ton.org/develop/howto/blockchain-configs#param-20-and-21
+
+:::
### Unbounded Gas Usage After Message Acceptance
diff --git a/docs/src/content/docs/book/func.mdx b/docs/src/content/docs/book/func.mdx
index c491a8f7b..9bc3b8e79 100644
--- a/docs/src/content/docs/book/func.mdx
+++ b/docs/src/content/docs/book/func.mdx
@@ -1,5 +1,6 @@
---
title: Compatibility with FunC
+description: "Tact compiles to FunC and maps all its entities directly to various FunC and TL-B types."
---
Tact itself compiles to FunC and maps all its entities directly to various FunC and TL-B types.
diff --git a/docs/src/content/docs/book/functions.mdx b/docs/src/content/docs/book/functions.mdx
index 10e8f32d4..ab96a9a98 100644
--- a/docs/src/content/docs/book/functions.mdx
+++ b/docs/src/content/docs/book/functions.mdx
@@ -1,5 +1,6 @@
---
-title: Functions and their types
+title: Functions
+description: "Global, asm, native functions, as well as receivers, getters and storage functions, plus the many attributes that allow for great flexibility and expressivity of Tact language"
---
Functions in Tact could be defined in different ways:
diff --git a/docs/src/content/docs/book/import.mdx b/docs/src/content/docs/book/import.mdx
index ec60ce2d5..019bc5e9d 100644
--- a/docs/src/content/docs/book/import.mdx
+++ b/docs/src/content/docs/book/import.mdx
@@ -1,5 +1,6 @@
---
title: Importing code
+description: "Tact allows you to import Tact and FunC code, and has a versatile set of standard libraries"
---
Tact allows you to import Tact and [FunC](https://docs.ton.org/develop/func/overview) code — any given `.tact` or `.fc`/`.func` file can be imported into your project using the `import{:tact}` keyword.
diff --git a/docs/src/content/docs/book/index.mdx b/docs/src/content/docs/book/index.mdx
index 247dfa0e9..ebd63f738 100644
--- a/docs/src/content/docs/book/index.mdx
+++ b/docs/src/content/docs/book/index.mdx
@@ -1,5 +1,6 @@
---
title: Book overview
+description: "Book section — an introductory book about the Tact language"
---
import { LinkCard, CardGrid, Steps } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/book/integers.mdx b/docs/src/content/docs/book/integers.mdx
index 5b1d6af13..981f891fd 100644
--- a/docs/src/content/docs/book/integers.mdx
+++ b/docs/src/content/docs/book/integers.mdx
@@ -1,5 +1,6 @@
---
title: Integers
+description: "Arithmetic in smart contracts on TON is always done with integers and never with floats"
---
Arithmetic in smart contracts on TON is always done with integers and never with floating-point numbers since the floats are [unpredictable](https://learn.microsoft.com/en-us/cpp/build/why-floating-point-numbers-may-lose-precision). Therefore, the big accent goes on integers and their handling.
diff --git a/docs/src/content/docs/book/lifecycle.mdx b/docs/src/content/docs/book/lifecycle.mdx
index 4b5485b04..4629d3948 100644
--- a/docs/src/content/docs/book/lifecycle.mdx
+++ b/docs/src/content/docs/book/lifecycle.mdx
@@ -1,5 +1,6 @@
---
title: Message Lifecycle
+description: "Every transaction on TON Blockchain has multiple stages, where compute and action ones are the most important for message lifecycle"
---
There are several stages of message processing by a contract, there are more of them, but we would focus on the most important ones:
diff --git a/docs/src/content/docs/book/maps.mdx b/docs/src/content/docs/book/maps.mdx
index 7f01b599b..0eb18a9a7 100644
--- a/docs/src/content/docs/book/maps.mdx
+++ b/docs/src/content/docs/book/maps.mdx
@@ -1,5 +1,6 @@
---
title: Maps
+description: "The composite type map is used as a way to associate keys with corresponding values of various types"
---
The [composite type](/book/types#composite-types) `mapㅤ
diff --git a/docs/src/content/docs/ref/core-advanced.mdx b/docs/src/content/docs/ref/core-advanced.mdx index 7462115bb..e52ba2aad 100644 --- a/docs/src/content/docs/ref/core-advanced.mdx +++ b/docs/src/content/docs/ref/core-advanced.mdx @@ -1,5 +1,6 @@ --- title: Advanced +description: "Advanced, niche or dangerous functions from the Core library of Tact" --- Various niche, dangerous or unstable features which can produce unexpected results and are meant to be used by the more experienced users. diff --git a/docs/src/content/docs/ref/core-base.mdx b/docs/src/content/docs/ref/core-base.mdx index 532040bc7..c8def1b4f 100644 --- a/docs/src/content/docs/ref/core-base.mdx +++ b/docs/src/content/docs/ref/core-base.mdx @@ -1,5 +1,6 @@ --- title: Base trait +description: "Every contract and trait in Tact implicitly inherits the BaseTrait trait" --- Every [contract](/book/contracts) and [trait](/book/types#traits) in Tact implicitly [inherits](/book/contracts#traits) the `BaseTrait{:tact}` trait, which contains a number of the most useful [internal functions](/book/contracts#internal-functions) for any kind of contract, and a constant `self.storageReserve{:tact}` aimed at advanced users of Tact. diff --git a/docs/src/content/docs/ref/core-cells.mdx b/docs/src/content/docs/ref/core-cells.mdx index 06a1c1ba0..39f183205 100644 --- a/docs/src/content/docs/ref/core-cells.mdx +++ b/docs/src/content/docs/ref/core-cells.mdx @@ -1,5 +1,6 @@ --- title: Cells, Builders and Slices +description: "Various Cell, Builder and Slice functions from the Core library of Tact" --- [`Cell{:tact}`][cell] is a low-level [primitive][p] that represents data in TON Blockchain. Cells consist of $1023$ bits of data with up to $4$ references to another cells. They are read-only and immutable, and cannot have cyclic references. diff --git a/docs/src/content/docs/ref/core-common.mdx b/docs/src/content/docs/ref/core-common.mdx index 06be1b7ca..c3f541eab 100644 --- a/docs/src/content/docs/ref/core-common.mdx +++ b/docs/src/content/docs/ref/core-common.mdx @@ -1,5 +1,6 @@ --- title: Common +description: "Commonly used global static functions from the Core library of Tact" --- List of the most commonly used built-in [global static functions](/book/functions#global-static-functions). diff --git a/docs/src/content/docs/ref/core-comptime.mdx b/docs/src/content/docs/ref/core-comptime.mdx index f37459a08..5ab3ff4f0 100644 --- a/docs/src/content/docs/ref/core-comptime.mdx +++ b/docs/src/content/docs/ref/core-comptime.mdx @@ -1,5 +1,6 @@ --- title: Compile-time +description: "Various compile-time global functions from the Core library of Tact" --- This page lists all the built-in [global static functions](/book/functions#global-static-functions), which are evaluated at the time of building the Tact project and cannot work with non-constant, run-time data. These functions are commonly referred to as "compile-time functions". diff --git a/docs/src/content/docs/ref/core-debug.mdx b/docs/src/content/docs/ref/core-debug.mdx index 3c80496a8..f380d2104 100644 --- a/docs/src/content/docs/ref/core-debug.mdx +++ b/docs/src/content/docs/ref/core-debug.mdx @@ -1,5 +1,6 @@ --- title: Debug +description: "Various debugging functions from the Core library of Tact" --- List of functions commonly used for debugging smart contracts in Tact. diff --git a/docs/src/content/docs/ref/core-math.mdx b/docs/src/content/docs/ref/core-math.mdx index 6e6a36714..2ff8ac884 100644 --- a/docs/src/content/docs/ref/core-math.mdx +++ b/docs/src/content/docs/ref/core-math.mdx @@ -1,5 +1,6 @@ --- title: Math +description: "Various math helper functions from the Core library of Tact" --- Various math helper functions. diff --git a/docs/src/content/docs/ref/core-random.mdx b/docs/src/content/docs/ref/core-random.mdx index c0aa93f2e..b912ab88e 100644 --- a/docs/src/content/docs/ref/core-random.mdx +++ b/docs/src/content/docs/ref/core-random.mdx @@ -1,5 +1,6 @@ --- title: Random number generation +description: "Various random number generation functions from the Core library of Tact" --- Random number generation for Tact smart contracts. diff --git a/docs/src/content/docs/ref/core-strings.mdx b/docs/src/content/docs/ref/core-strings.mdx index ef4fcaff2..3e836cbee 100644 --- a/docs/src/content/docs/ref/core-strings.mdx +++ b/docs/src/content/docs/ref/core-strings.mdx @@ -1,5 +1,6 @@ --- title: Strings and StringBuilders +description: "Various String and StringBuilder functions from the Core library of Tact" --- Strings are immutable sequences of characters, which means that once a [`String{:tact}`][p] is created, it cannot be changed. Strings are useful to store text, and so they can be converted to [`Cell{:tact}`][cell] type to be used as message bodies. diff --git a/docs/src/content/docs/ref/evolution/otp-001.mdx b/docs/src/content/docs/ref/evolution/otp-001.mdx index 5330d78f7..b93dc3a5e 100644 --- a/docs/src/content/docs/ref/evolution/otp-001.mdx +++ b/docs/src/content/docs/ref/evolution/otp-001.mdx @@ -1,5 +1,6 @@ --- title: "OTP-001: Supported Interfaces" +description: "This proposal recommends a way to introspect smart contracts and find out what interfaces they support" sidebar: order: 1 --- diff --git a/docs/src/content/docs/ref/evolution/otp-002.mdx b/docs/src/content/docs/ref/evolution/otp-002.mdx index 599063769..ef071b385 100644 --- a/docs/src/content/docs/ref/evolution/otp-002.mdx +++ b/docs/src/content/docs/ref/evolution/otp-002.mdx @@ -1,5 +1,6 @@ --- title: "OTP-002: Contract ABI" +description: "This proposal defines an ABI to communicate with deployed smart contracts" sidebar: order: 2 --- diff --git a/docs/src/content/docs/ref/evolution/otp-003.mdx b/docs/src/content/docs/ref/evolution/otp-003.mdx index b8781cb92..b11faacd2 100644 --- a/docs/src/content/docs/ref/evolution/otp-003.mdx +++ b/docs/src/content/docs/ref/evolution/otp-003.mdx @@ -1,5 +1,6 @@ --- title: "OTP-003: Self-ABI reporting" +description: "This proposal defines how to report the contract's ABI using the IPFS link" sidebar: order: 3 --- diff --git a/docs/src/content/docs/ref/evolution/otp-004.mdx b/docs/src/content/docs/ref/evolution/otp-004.mdx index 527aed5b5..73f8b7180 100644 --- a/docs/src/content/docs/ref/evolution/otp-004.mdx +++ b/docs/src/content/docs/ref/evolution/otp-004.mdx @@ -1,5 +1,6 @@ --- title: "OTP-004: Auto Encoder" +description: "This proposal defines a way to automatically build a serialization layout for a given structure" sidebar: order: 4 --- diff --git a/docs/src/content/docs/ref/evolution/otp-005.mdx b/docs/src/content/docs/ref/evolution/otp-005.mdx index 9334cdc0e..a5843b5a1 100644 --- a/docs/src/content/docs/ref/evolution/otp-005.mdx +++ b/docs/src/content/docs/ref/evolution/otp-005.mdx @@ -1,5 +1,6 @@ --- title: "OTP-005: Argument-addressable contracts" +description: "This proposal defines a way to address contracts by their arguments instead of their initial data" sidebar: order: 5 --- diff --git a/docs/src/content/docs/ref/evolution/otp-006.mdx b/docs/src/content/docs/ref/evolution/otp-006.mdx index 993b1ec86..8fd6a78c8 100644 --- a/docs/src/content/docs/ref/evolution/otp-006.mdx +++ b/docs/src/content/docs/ref/evolution/otp-006.mdx @@ -1,5 +1,6 @@ --- title: "OTP-006: Contract Package" +description: "This proposal defines a way to package compile contracts, their dependencies, and all related metadata into a single file" sidebar: order: 6 --- diff --git a/docs/src/content/docs/ref/evolution/overview.mdx b/docs/src/content/docs/ref/evolution/overview.mdx index d1937341f..e4c6b1e27 100644 --- a/docs/src/content/docs/ref/evolution/overview.mdx +++ b/docs/src/content/docs/ref/evolution/overview.mdx @@ -1,5 +1,6 @@ --- title: Evolution overview +description: "Evolution sub-section contains all standards that are defined by the Tact Foundation and are used in the evolution process of the Tact and TON ecosystem" sidebar: label: Overview order: 0 diff --git a/docs/src/content/docs/ref/index.mdx b/docs/src/content/docs/ref/index.mdx index aa53c431d..43f75f15a 100644 --- a/docs/src/content/docs/ref/index.mdx +++ b/docs/src/content/docs/ref/index.mdx @@ -1,5 +1,6 @@ --- title: Reference overview +description: "Reference section — a place for discovering the Tact's standard library, grammar specification and evolution process" --- import { LinkCard, CardGrid, Steps } from '@astrojs/starlight/components'; diff --git a/docs/src/content/docs/ref/spec.mdx b/docs/src/content/docs/ref/spec.mdx index 3b8c57c08..8e09ecbf8 100644 --- a/docs/src/content/docs/ref/spec.mdx +++ b/docs/src/content/docs/ref/spec.mdx @@ -1,5 +1,6 @@ --- title: Tact Specification +description: "Tact grammar used in its compiler is written in an Ohm language, which is based on parsing expression grammars (PEGs), which are a formal way of describing syntax, similar to regular expressions and context-free grammars." pagefind: false # hide the page from the search index --- diff --git a/docs/src/content/docs/ref/standard-libraries.mdx b/docs/src/content/docs/ref/standard-libraries.mdx index 3000c0a05..b8e8289af 100644 --- a/docs/src/content/docs/ref/standard-libraries.mdx +++ b/docs/src/content/docs/ref/standard-libraries.mdx @@ -1,5 +1,6 @@ --- title: Standard libraries overview +description: "Some libraries come bundled with Tact compiler, but aren't automatically included to your project until explicitly made to" --- Some libraries (also referred to as standard libraries or stdlibs) come bundled with Tact compiler, but aren't automatically included to your project until explicitly made to. diff --git a/docs/src/content/docs/ref/stdlib-config.mdx b/docs/src/content/docs/ref/stdlib-config.mdx index 5443f0855..1ad24acdc 100644 --- a/docs/src/content/docs/ref/stdlib-config.mdx +++ b/docs/src/content/docs/ref/stdlib-config.mdx @@ -1,5 +1,6 @@ --- title: "@stdlib/config" +description: "Provides functions for config and elector Address retrieval" --- Provides functions for config and elector Address retrieval. diff --git a/docs/src/content/docs/ref/stdlib-content.mdx b/docs/src/content/docs/ref/stdlib-content.mdx index 4acf52b79..0f0335fe8 100644 --- a/docs/src/content/docs/ref/stdlib-content.mdx +++ b/docs/src/content/docs/ref/stdlib-content.mdx @@ -1,5 +1,6 @@ --- title: "@stdlib/content" +description: "Provides a function for encoding an off-chain link from a String to a Cell" --- Provides a function for encoding an off-chain link from a [`String{:tact}`][p] to a [`Cell{:tact}`][cell]. diff --git a/docs/src/content/docs/ref/stdlib-deploy.mdx b/docs/src/content/docs/ref/stdlib-deploy.mdx index 2af456b2a..7bcc56211 100644 --- a/docs/src/content/docs/ref/stdlib-deploy.mdx +++ b/docs/src/content/docs/ref/stdlib-deploy.mdx @@ -1,5 +1,6 @@ --- title: "@stdlib/deploy" +description: "Provides unified mechanisms for deployments" --- Provides unified mechanisms for deployments. diff --git a/docs/src/content/docs/ref/stdlib-dns.mdx b/docs/src/content/docs/ref/stdlib-dns.mdx index 2dcf372e3..39ba1cbc0 100644 --- a/docs/src/content/docs/ref/stdlib-dns.mdx +++ b/docs/src/content/docs/ref/stdlib-dns.mdx @@ -1,5 +1,6 @@ --- title: "@stdlib/dns" +description: "Provides means for resolution of DNS names on TON" --- Provides means for resolution of [DNS](https://docs.ton.org/participate/web3/dns) names. diff --git a/docs/src/content/docs/ref/stdlib-ownable.mdx b/docs/src/content/docs/ref/stdlib-ownable.mdx index ef75516c6..f4b8d4a6e 100644 --- a/docs/src/content/docs/ref/stdlib-ownable.mdx +++ b/docs/src/content/docs/ref/stdlib-ownable.mdx @@ -1,8 +1,9 @@ --- title: "@stdlib/ownable" +description: "Provides traits for ownable contracts, which are commonly required by other traits" --- -Provides [traits](/book/types#composite-types) for ownable contracts. This is most commonly used trait that is required by most other traits. +Provides [traits](/book/types#composite-types) for ownable contracts. These traits are commonly required by other traits. To use this library, import `@stdlib/ownable`: diff --git a/docs/src/content/docs/ref/stdlib-stoppable.mdx b/docs/src/content/docs/ref/stdlib-stoppable.mdx index 13d5b00c3..a3435496b 100644 --- a/docs/src/content/docs/ref/stdlib-stoppable.mdx +++ b/docs/src/content/docs/ref/stdlib-stoppable.mdx @@ -1,5 +1,6 @@ --- title: "@stdlib/stoppable" +description: "Provides traits that allow to stop a contract, which are useful for emergency or maintenance modes" --- Provides [traits](/book/types#composite-types) that allow to stop a [contract](/book/contracts). Useful for emergency or maintenance modes. Requires an [`Ownable{:tact}`](/ref/stdlib-ownable#ownable) trait from [`@stdlib/ownable`](/ref/stdlib-ownable). This trait just manages a single flag `stopped` in the contract and handling stopped state have to be done in the contract itself. From e1f1de213c3863afd441b1a23a6afb5ff50fae1a Mon Sep 17 00:00:00 2001 From: Novus Nota <68142933+novusnota@users.noreply.github.com> Date: Sun, 6 Oct 2024 22:12:54 +0200 Subject: [PATCH 4/4] chore: CHANGELOG and revert of the "deprecated" function --- CHANGELOG.md | 2 ++ cspell.json | 1 + docs/inline-code-highlighting.js | 4 ++-- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f9c237f96..882f22067 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `&&=`, `||=`, `>>=` and `<<=` augmented assignment operators: PR [#853](https://github.com/tact-lang/tact/pull/853) - New CSpell dictionaries: TVM instructions and adjusted list of Fift words: PR [#881](https://github.com/tact-lang/tact/pull/881) +- Docs: the `description` property to the frontmatter of the each page for better SEO: PR [#916](https://github.com/tact-lang/tact/pull/916) ### Changed @@ -19,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Collisions in getter method ids are now handled and reported properly: PR [#875](https://github.com/tact-lang/tact/pull/875) +- Docs: layout of tables, syntax highlighting, Chinese translations of sidebar separators: PR [#916](https://github.com/tact-lang/tact/pull/916) ### Release contributors diff --git a/cspell.json b/cspell.json index 37816132d..382c2ef3a 100644 --- a/cspell.json +++ b/cspell.json @@ -45,6 +45,7 @@ "funcfiftlib", "funcid", "funs", + "frontmatter", "Georgiy", "gettest", "Héctor", diff --git a/docs/inline-code-highlighting.js b/docs/inline-code-highlighting.js index eab2324a5..9013a817a 100644 --- a/docs/inline-code-highlighting.js +++ b/docs/inline-code-highlighting.js @@ -9,8 +9,8 @@ import { toString } from 'hast-util-to-string'; import { bundledLanguages, createHighlighter, + createWasmOnigEngine, } from 'shiki'; -import { createOnigurumaEngine } from 'shiki/engine/oniguruma'; import fs from 'node:fs'; // Import custom grammars @@ -71,7 +71,7 @@ export default function rehypeInlineCodeHighlighting() { ], // TODO: Made the 'name' lowercase in the TextMate grammars langAlias: { fc: 'func' }, - engine: await createOnigurumaEngine(import('shiki/wasm')), + engine: await createWasmOnigEngine(import('shiki/wasm')), }); // Apply highlighting to each target node