Skip to content
This repository was archived by the owner on Dec 12, 2024. It is now read-only.

Commit 65fb5d4

Browse files
novusnotanovusnota
committed
chore: Fix internal linkage
1 parent a241764 commit 65fb5d4

17 files changed

+128
-113
lines changed

‎pages/book/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Book Overview
1+
# Book overview
22

33
import { Cards, Steps } from 'nextra/components'
44

55
Welcome to **The Tact Book** section (or just **The Book**), — an introductory book about the Tact language.
66

7-
Here are it's main contents:
7+
Here are its main contents:
88

99
<Steps>
1010

‎pages/cookbook/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cookbook Overview
1+
# Cookbook overview
22

33
import { Callout, Steps, Cards } from 'nextra/components'
44
import { OneIcon, FormulaIcon, DiagramIcon, DropperIcon, BoxIcon, IdCardIcon, WarningIcon, StarsIcon, RowsIcon, GearIcon, LightningIcon } from '@components/icons'

‎pages/ecosystem/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Overview
1+
# Ecosystem overview
22

33
import { Cards, Steps } from 'nextra/components'
44

55
Welcome to the **Ecosystem** section — a bird-eye overview of Tact ecosystem, tools and ways you can start contributing to those!
66

7-
Here are it's main contents:
7+
Here are its main contents:
88

99
<Steps>
1010

@@ -20,4 +20,4 @@ Here are it's main contents:
2020
/>
2121
</Cards>
2222

23-
</Steps>
23+
</Steps>

‎pages/ref/_meta.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export default {
1616
'api-advanced': 'Advanced',
1717
'-- Stdlib': {
1818
type: 'separator',
19-
title: 'Standard Libraries',
19+
title: 'Standard libraries',
2020
},
2121
'standard-libraries': 'Overview',
2222
'stdlib-config': '@stdlib/config',

‎pages/ref/api-advanced.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Advanced
1+
# Miscellaneous
22

33
import { Callout } from 'nextra/components'
44

5-
Dangerous or unstable features meant to be used by advanced users only.
5+
Various niche, dangerous or unstable features which can produce unexpected results and are meant to be used by the more experienced users.
66

77
<Callout type="warning" emoji="⚠️">
8+
89
Proceed with caution.
10+
911
</Callout>
1012

1113
## readForwardFee
@@ -122,4 +124,4 @@ Function `raw_reserve` is roughly equivalent to creating an outbound message car
122124

123125
<Callout type="warning" emoji="⚠️">
124126
Currently, `amount` must be a non-negative integer, and `mode` must be in the range 0..15, inclusive.
125-
</Callout>
127+
</Callout>

‎pages/ref/api-common.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import { Callout } from 'nextra-theme-docs'
44

55
List of the most commonly used built-in [global static functions](/book/functions#global-static-functions).
66

7-
87
## sender
98

109
```tact
@@ -87,7 +86,7 @@ let meMyselfAndI: Address = myAddress();
8786
fun newAddress(chain: Int, hash: Int): Address;
8887
```
8988

90-
Creates a new [`Address{:tact}`][p] based on the [`chain` id](https://ton-blockchain.github.io/docs/#/overviews/TON_blockchain_overview) and the [SHA-256](/language/ref/math#sha256) encoded [`hash` value](https://docs.ton.org/learn/overviews/addresses#account-id).
89+
Creates a new [`Address{:tact}`][p] based on the [`chain` id](https://ton-blockchain.github.io/docs/#/overviews/TON_blockchain_overview) and the [SHA-256](/ref/stdlib-math#sha256) encoded [`hash` value](https://docs.ton.org/learn/overviews/addresses#account-id).
9190

9291
Usage example:
9392

‎pages/ref/api-comptime.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,21 @@ ton("0.1"); // 10^8 nanoToncoins, which is equal to 0.1 Toncoin
6060
ton("0.000000001"); // 1 nanoToncoin, which is equal to 10^-9 Toncoins
6161
```
6262

63+
## pow
64+
65+
```tact
66+
fun pow(a: Int, b: Int): Int;
67+
```
68+
69+
A compile-time function that computes the exponent `b` of value `a`. Exponent `b` must be non-negative.
70+
71+
Usage example:
72+
73+
```tact
74+
pow(2, 3); // raises 2 to the 3rd power, which is 8
75+
pow(5, 0); // raises 5 to the power 0, which always produces 1
76+
```
77+
6378
[p]: /book/types#primitive-types
6479
[bool]: /book/types#booleans
6580
[int]: /book/integers

‎pages/ref/api-math.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,3 @@ Computes the maximum of two integers `x` and `y`.
4141
fun abs(x: Int): Int
4242
```
4343
Computes the absolute value of the integer `x`.
44-
45-
## pow
46-
```tact
47-
fun pow(a: Int, b: Int): Int
48-
```
49-
Computes the exponent `b` of `a`.

‎pages/ref/evolution/overview.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Overview
1+
# Evolution overview
22

33
import { Cards } from 'nextra/components'
44

@@ -11,32 +11,32 @@ Additionaly, it features TEPs (TON Enhancement Proposals) and the up-to-date cha
1111
<Cards.Card
1212
arrow
1313
title="OTP-001"
14-
href="/language/evolution/OTP-001"
14+
href="/ref/evolution/OTP-001"
1515
/>
1616
<Cards.Card
1717
arrow
1818
title="OTP-002"
19-
href="/language/evolution/OTP-002"
19+
href="/ref/evolution/OTP-002"
2020
/>
2121
<Cards.Card
2222
arrow
2323
title="OTP-003"
24-
href="/language/evolution/OTP-003"
24+
href="/ref/evolution/OTP-003"
2525
/>
2626
<Cards.Card
2727
arrow
2828
title="OTP-004"
29-
href="/language/evolution/OTP-004"
29+
href="/ref/evolution/OTP-004"
3030
/>
3131
<Cards.Card
3232
arrow
3333
title="OTP-005"
34-
href="/language/evolution/OTP-005"
34+
href="/ref/evolution/OTP-005"
3535
/>
3636
<Cards.Card
3737
arrow
3838
title="OTP-006"
39-
href="/language/evolution/OTP-006"
39+
href="/ref/evolution/OTP-006"
4040
/>
4141
</Cards>
4242

@@ -48,4 +48,4 @@ List of [merged TEPs](https://github.com/ton-blockchain/TEPs#merged-teps).
4848

4949
## Changelog
5050

51-
All notable changes to the main Tact repository are documented in the [CHANGELOG.md](https://github.com/tact-lang/tact/blob/main/CHANGELOG.md).
51+
All notable changes to the main Tact repository are documented in the [CHANGELOG.md](https://github.com/tact-lang/tact/blob/main/CHANGELOG.md).

‎pages/ref/index.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
1-
# Overview
1+
# Reference overview
22

33
import { Cards, Steps } from 'nextra/components'
44

55
Welcome to the **Language** section of Tact documentation — a place for becoming more familiar with the language in much more depth compared to the [Book](/book).
66

7-
Here are it's main contents:
7+
Here are its main contents:
88

99
<Steps>
1010

11-
### Reference
11+
### API Reference
1212

13-
[Reference](/language/ref/common) is a comprehensive list of language syntax and semantics. More detailed than the [Book](/book) at the expense of no additional guidance — targeted at more experienced programmers.
13+
[API Reference](/ref/stdlib-common) gives a comprehensive list of auto-included constructs and provides examples of their usage.
1414

1515
<Cards>
1616
<Cards.Card
1717
arrow
18-
title="Go to the Reference"
19-
href="/language/ref/common"
18+
title="Go to the API Reference"
19+
href="/ref/common"
2020
/>
2121
</Cards>
2222

23-
### Libraries
23+
### Standard libraries
2424

25-
[Libraries](/language/libs/overview) sub-section explains how to use the bundled libraries, how to import external code and lists all the contents of the standard library.
25+
[Standard libraries](/ref/standard-libraries) sub-section explains how to use the bundled libraries, lists all their contents with examples of their usage.
2626

2727
<Cards>
2828
<Cards.Card
2929
arrow
30-
title="Go to the Libraries"
31-
href="/language/libs/overview"
30+
title="Go to Standard libraries"
31+
href="/ref/standard-libraries"
3232
/>
3333
</Cards>
3434

3535
### Specification
3636

37-
[Specification](/language/spec) page provides full Tact grammar written in Ohm language, which is used in the Tact's compiler. Aimed at more experienced programmers, but generally can still be very handy to quickly grasp all of the possible syntax in the language.
37+
[Specification](/ref/spec) page provides full Tact grammar written in Ohm language, which is used in the Tact's compiler. Aimed at more experienced programmers, but generally can still be very handy to quickly grasp all of the possible syntax in the language.
3838

3939
<Cards>
4040
<Cards.Card
4141
arrow
4242
title="Go to the Specification"
43-
href="/language/spec"
43+
href="/ref/spec"
4444
/>
4545
</Cards>
4646

4747
### Evolution
4848

49-
Finally, [Evolution](/language/evolution/overview) sub-section gives insight on important decisions about language semantics, Tact's future and links to the up-to-date changelog of Tact updates.
49+
Finally, [Evolution](/ref/evolution/overview) sub-section gives insight on important decisions about language semantics, Tact's future and links to the up-to-date changelog of Tact updates.
5050

5151
<Cards>
5252
<Cards.Card
5353
arrow
5454
title="Go to the Evolution"
55-
href="/language/evolution/overview"
55+
href="/ref/evolution/overview"
5656
/>
5757
</Cards>
5858

‎pages/ref/standard-libraries.mdx

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,46 @@ import { Callout } from 'nextra-theme-docs'
44

55
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.
66

7-
To import any standard library, use the `import{:tact}` statement followed by the name of that library in a [string](/language/ref/strings), like so:
7+
To import any standard library, use the [`import{:tact}` keyword](/book/import) followed by the name of that library in a [string][p], like so:
88

99
```tact
10-
import "@stdlib/deploy"; // this would include everything from @stdlib/deploy library into your codebase
10+
// This would include everything from @stdlib/deploy into your codebase:
11+
import "@stdlib/deploy";
1112
```
1213

1314
## List of standard libraries: [#list]
1415

15-
Library | Description | Commonly used APIs
16-
:--------------------- | :--------------------------------------------------------------- | :-----------------
17-
[@stdlib/config][1] | Config and elector address retrieval. | `getConfigAddress`, `getElectorAddress`
18-
[@stdlib/content][2] | Encoding off-chain link [strings][str] to a [Cell][cell]. | `createOffchainContent`
19-
[@stdlib/deploy][3] | Unified mechanism for deployments. | `Deployable`, `FactoryDeployable`
20-
[@stdlib/dns][4] | Resolution of [DNS][dns] names. | `DNSResolver`, `dnsInternalVerify`
21-
[@stdlib/ownable][5] | Traits for ownership management. | `Ownable`, `OwnableTransferable`
22-
[@stdlib/stoppable][6] | Traits that allow contract stops. Requires [@stdlib/ownable][5]. | `Stoppable`, `Resumable`
23-
24-
[1]: /language/libs/config
25-
[2]: /language/libs/content
26-
[3]: /language/libs/deploy
27-
[4]: /language/libs/dns
28-
[5]: /language/libs/ownable
29-
[6]: /language/libs/stoppable
30-
[cell]: /language/ref/cells
31-
[str]: /language/ref/strings
16+
Library | Description | Commonly used APIs
17+
:----------------------- | :--------------------------------------------------------------- | :-----------------
18+
[`@stdlib/config`][1] | Config and elector address retrieval. | [`getConfigAddress{:tact}`][gca], [`getElectorAddress{:tact}`][gea]
19+
[`@stdlib/content`][2] | Encoding off-chain link [strings][p] to a [`Cell{:tact}`][p]. | [`createOffchainContent{:tact}`][coff]
20+
[`@stdlib/deploy`][3] | Unified mechanism for deployments. | [`Deployable{:tact}`][dep], [`FactoryDeployable{:tact}`][fcd]
21+
[`@stdlib/dns`][4] | Resolution of [DNS][dns] names. | [`DNSResolver{:tact}`][dnsr], [`dnsInternalVerify{:tact}`][dnsi]
22+
[`@stdlib/ownable`][5] | Traits for ownership management. | [`Ownable{:tact}`][own], [`OwnableTransferable{:tact}`][ownt]
23+
[`@stdlib/stoppable`][6] | Traits that allow contract stops. Requires [@stdlib/ownable][5]. | [`Stoppable{:tact}`][stp], [`Resumable{:tact}`][res]
24+
25+
[1]: /ref/stdlib-config
26+
[gca]: /ref/stdlib-config#getconfigaddress
27+
[gea]: /ref/stdlib-config#getelectoraddress
28+
29+
[2]: /ref/stdlib-content
30+
[coff]: /ref/stdlib-content#createoffchaincontent
31+
32+
[3]: /ref/stdlib-deploy
33+
[dep]: /ref/stdlib-deploy#deployable
34+
[fcd]: /ref/stdlib-deploy#factorydeployable
35+
36+
[4]: /ref/stdlib-dns
37+
[dnsr]: /ref/stdlib-dns#dnsresolver
38+
[dnsi]: /ref/stdlib-dns#dnsinternalverify
39+
40+
[5]: /ref/stdlib-ownable
41+
[own]: /ref/stdlib-ownable#ownable
42+
[ownt]: /ref/stdlib-ownable#ownabletransferable
43+
44+
[6]: /ref/stdlib-stoppable
45+
[stp]: /ref/stdlib-stoppable#stoppable
46+
[res]: /ref/stdlib-stoppable#resumable
47+
48+
[p]: /book/types#primitive-types
3249
[dns]: https://docs.ton.org/participate/web3/dns

‎pages/ref/stdlib-config.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@ import "@stdlib/config";
1212

1313
### getConfigAddress
1414

15-
Retrives config parameter 0 as an Address.
16-
17-
Signature:
18-
1915
```tact
2016
fun getConfigAddress(): Address;
2117
```
2218

19+
Retrives config parameter 0 as an [`Address{:tact}`][p].
20+
2321
Source code:
2422

2523
```tact
@@ -32,14 +30,12 @@ fun getConfigAddress(): Address {
3230

3331
### getElectorAddress
3432

35-
Retrives config parameter 1 as an Address.
36-
37-
Signature:
38-
3933
```tact
4034
fun getElectorAddress(): Address;
4135
```
4236

37+
Retrives config parameter 1 as an [`Address{:tact}`][p].
38+
4339
Source code:
4440

4541
```tact
@@ -52,4 +48,6 @@ fun getElectorAddress(): Address {
5248

5349
## Sources
5450

55-
* [config.tact](https://github.com/tact-lang/tact/blob/61541b7783098e1af669faccd7d2334c10981c72/stdlib/libs/config.tact)
51+
* [config.tact](https://github.com/tact-lang/tact/blob/61541b7783098e1af669faccd7d2334c10981c72/stdlib/libs/config.tact)
52+
53+
[p]: /book/types#primitive-types

‎pages/ref/stdlib-content.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @stdlib/content
22

3-
Provides a function for encoding an off-chain link [string](/language/ref/strings) to a [Cell](/language/ref/cells).
3+
Provides a function for encoding an off-chain link from a [`String{:tact}`][p] to a [`Cell{:tact}`][p].
44

55
To use this library, import `@stdlib/content`:
66

@@ -12,14 +12,12 @@ import "@stdlib/content";
1212

1313
### createOffchainContent
1414

15-
Encodes an off-chain `link` [string](/language/ref/strings) to a [Cell](/language/ref/cells).
16-
17-
Signature:
18-
1915
```tact
2016
fun createOffchainContent(link: String): Cell;
2117
```
2218

19+
Encodes an off-chain `link` from a [`String{:tact}`][p] to a [`Cell{:tact}`][p].
20+
2321
Source code:
2422

2523
```tact
@@ -33,3 +31,6 @@ fun createOffchainContent(link: String): Cell {
3331
## Sources
3432

3533
* [content.tact](https://github.com/tact-lang/tact/blob/61541b7783098e1af669faccd7d2334c10981c72/stdlib/libs/content.tact)
34+
35+
[p]: /book/types#primitive-types
36+

0 commit comments

Comments
 (0)