Skip to content

Commit 201de7a

Browse files
committed
Sync recent changes to new structure
Signed-off-by: a-zorina <[email protected]>
1 parent 101c269 commit 201de7a

40 files changed

+700
-263
lines changed

.vitepress/config.mts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,14 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
7272
link: '/guide/tutorials/',
7373
items: [
7474
/* a common lang-agnostic section will go here */
75-
76-
{
77-
text: 'Python 3',
78-
link: '/guide/tutorials/python',
79-
},
8075
{
8176
text: 'Rust',
8277
link: '/guide/tutorials/rust',
8378
},
79+
{
80+
text: 'Python 3',
81+
link: '/guide/tutorials/python',
82+
},
8483
{
8584
text: 'Kotlin/Java',
8685
link: '/guide/tutorials/kotlin-java',

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This repository contains the source files for [Hyperledger Iroha 2 Documentation
44

55
The tutorial is suitable for both experienced and novice users. It explains Iroha 2 concepts and features, and also offers language-specific step-by-step guides for these programming languages:
66

7-
- [CLI](https://hyperledger.github.io/iroha-2-docs/guide/operate-iroha-via-cli.html)
7+
- [CLI](https://hyperledger.github.io/iroha-2-docs/guide/operate-iroha-2-via-cli.html)
88
- [Python](https://hyperledger.github.io/iroha-2-docs/guide/python.html)
99
- [Rust](https://hyperledger.github.io/iroha-2-docs/guide/rust.html)
1010
- [Kotlin/Java](https://hyperledger.github.io/iroha-2-docs/guide/kotlin-java.html)
1111
- [Javascript (TypeScript)](https://hyperledger.github.io/iroha-2-docs/guide/javascript.html)
1212

13-
If you are already familiar with Hyperledger Iroha, we invite you to read about [how Iroha 2 is different](https://hyperledger.github.io/iroha-2-docs/guide/iroha-2.html) from its previous version.
13+
If you are already familiar with Hyperledger Iroha, we invite you to read about [how Iroha 2 is different](https://hyperledger.github.io/iroha-2-docs/get-started/iroha-2.html) from its previous version.
1414

15-
Check the [Hyperledger Iroha 2](https://github.com/hyperledger/iroha/tree/iroha2-dev#hyperledger-iroha) repository for more detailed information about API and available features.
15+
Check the [Hyperledger Iroha](https://github.com/hyperledger/iroha/) repository for more detailed information about API and available features.
1616

1717
## Contribution
1818

src/blockchain/assets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ same as a £1 bill signed by the King of Spades).
99

1010
The assets can also be **mintable** (you can make more of them) and
1111
**non-mintable** (you can only specify their initial quantity in the
12-
[genesis block](/guide/configure/genesis)).
12+
[genesis block](/guide/configure/genesis.md)).
1313

1414
## Value Types
1515

@@ -76,7 +76,7 @@ Assets can be [registered](./instructions.md#un-register),
7676
Refer to one of the language-specific guides to walk you through the
7777
process of registering and minting assets in a blockchain:
7878

79-
- [CLI](/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets)
79+
- [CLI](/get-started/operate-iroha-2-via-cli.md#_6-register-and-mint-assets)
8080
- [Rust](/guide/tutorials/rust.md#_5-registering-and-minting-assets)
8181
- [Kotlin/Java](/guide/tutorials/kotlin-java.md#_5-registering-and-minting-assets)
8282
- [Python](/guide/tutorials/python.md#_5-registering-and-minting-assets)

src/blockchain/consensus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ fail. The same thing happens if the peers have different instructions.
3232

3333
[^1]:
3434
For prospective wizards, the
35-
[Iroha 2 Whitepaper](https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/iroha_2_whitepaper.md)
35+
[Iroha 2 Whitepaper](https://github.com/hyperledger/iroha/blob/main/docs/source/iroha_2_whitepaper.md)
3636
is a good start.

src/blockchain/data-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ domain_looking_glass *-- account_rabbit : registered in
8787

8888
| Language | Guide |
8989
| --------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
90-
| CLI | Register a [domain](/get-started/operate-iroha-via-cli.md#_3-register-a-domain), an [account](/get-started/operate-iroha-via-cli.md#_4-register-an-account), an [asset](/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets) |
90+
| CLI | Register a [domain](/get-started/operate-iroha-2-via-cli.md#_3-register-a-domain), an [account](/get-started/operate-iroha-2-via-cli.md#_4-register-an-account), an [asset](/get-started/operate-iroha-2-via-cli.md#_6-register-and-mint-assets) |
9191
| Rust | Register a [domain](/guide/tutorials/rust.md#_3-registering-a-domain), an [account](/guide/tutorials/rust.md#_4-registering-an-account), an [asset](/guide/tutorials/rust.md#_5-registering-and-minting-assets) |
9292
| Kotlin/Java | Register a [domain](/guide/tutorials/kotlin-java.md#_3-querying-and-registering-domains), an [account](/guide/tutorials/kotlin-java.md#_4-registering-an-account), an [asset](/guide/tutorials/kotlin-java.md#_5-registering-and-minting-assets) |
9393
| Python | Register a [domain](/guide/tutorials/python.md#_3-registering-a-domain), an [account](/guide/tutorials/python.md#_4-registering-an-account), an [asset](/guide/tutorials/python.md#_5-registering-and-minting-assets) |

src/blockchain/how-iroha-works.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
To understand how Iroha operates, let's draw parallels between a blockchain
44
and a computer. If the blockchain is the computer, then in this metaphor of
5-
ours the client binary (for example: [`iroha_client_cli`](/get-started/operate-iroha-via-cli))
5+
ours the client binary (for example: [`iroha`](/get-started/operate-iroha-2-via-cli.md))
66
is the keyboard, the blockchain is the hard drive, and the Iroha peer
77
software is the processor. Like a processor, Iroha accepts portable
88
instructions that modify what's written to the blockchain, allow certain
99
users to use the network, and lock others out.
1010

1111
Any operation that is run on-chain is written in terms of
12-
[Iroha Special Instructions (ISI)](/blockchain/instructions), and
12+
[Iroha Special Instructions (ISI)](/blockchain/instructions.md), and
1313
there is no other way of modifying the world state.
1414

1515
Each interaction with the blockchain is done via a _transaction_. A
1616
transaction is a collection of _instructions_, which are either glued
1717
together in sequence or compiled into what we affectionately call a
18-
[WASM](/blockchain/wasm) blob. You need these instructions to
18+
[WASM](/blockchain/wasm.md) blob. You need these instructions to
1919
register an account, remove an account, add X amount of Y currency, and so
2020
on.
2121

2222
To read the information encoded in the blocks of a blockchain (the current
23-
world state), you use [queries](/blockchain/queries). Queries are
23+
world state), you use [queries](/blockchain/queries.md). Queries are
2424
submitted like instructions, but they're not tracked and recorded in
2525
blocks, so they're much more lightweight. If you use queries as part of
2626
complicated logic (e.g. inside WASM), they have a non-negligible impact on

src/blockchain/instructions.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ all you need is the object that you want to register.
4040
| [Mint/Burn](#mint-burn) | assets, triggers (trigger repetitions), permission tokens | accounts |
4141
| [SetKeyValue/RemoveKeyValue](#setkeyvalue-removekeyvalue) | any objects that have [metadata](./metadata.md): accounts, domains, assets, asset definitions, triggers, transactions | |
4242
| [NewParameter/SetParameter](#newparameter-setparameter) | Iroha configuration parameters | |
43-
| [Grant/Revoke](#grant-revoke) | [roles, permission tokens](/blockchain/permissions) | accounts |
43+
| [Grant/Revoke](#grant-revoke) | [roles, permission tokens](/blockchain/permissions.md) | accounts |
4444
| [Transfer](#transfer) | assets | accounts |
4545
| [ExecuteTrigger](#executetrigger) | triggers | |
4646
| [If, Pair, Sequence](#composite-instructions) | any instructions | |
@@ -79,7 +79,7 @@ restrictions put on entity names.
7979
::: info
8080

8181
Note that depending on how you decide to set up your
82-
[genesis block](/guide/configure/genesis) in `genesis.json`
82+
[genesis block](/guide/configure/genesis.md) in `genesis.json`
8383
(specifically, whether or not you include registration of permission
8484
tokens), the process for registering an account can be very different. In
8585
general, we can summarise it like this:
@@ -91,7 +91,7 @@ general, we can summarise it like this:
9191
register another account.
9292

9393
We discuss these differences in great detail when we
94-
[compare private and public blockchains](/guide/configure/modes).
94+
[compare private and public blockchains](/guide/configure/modes.md).
9595

9696
:::
9797

@@ -109,7 +109,7 @@ process of registering objects in a blockchain:
109109

110110
| Language | Guide |
111111
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
112-
| CLI | Register a [domain](/get-started/operate-iroha-via-cli.md#_3-register-a-domain), an [account](/get-started/operate-iroha-via-cli.md#_4-register-an-account), an [asset](/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets) |
112+
| CLI | Register a [domain](/get-started/operate-iroha-2-via-cli.md#_3-register-a-domain), an [account](/get-started/operate-iroha-2-via-cli.md#_4-register-an-account), an [asset](/get-started/operate-iroha-2-via-cli.md#_6-register-and-mint-assets) |
113113
| Rust | Register a [domain](/guide/tutorials/rust.md#_3-registering-a-domain), an [account](/guide/tutorials/rust.md#_4-registering-an-account), an [asset](/guide/tutorials/rust.md#_5-registering-and-minting-assets) |
114114
| Kotlin/Java | Register a [domain](/guide/tutorials/kotlin-java.md#_3-querying-and-registering-domains), an [account](/guide/tutorials/kotlin-java.md#_4-registering-an-account), an [asset](/guide/tutorials/kotlin-java.md#_5-registering-and-minting-assets) |
115115
| Python | Register a [domain](/guide/tutorials/python.md#_3-registering-a-domain), an [account](/guide/tutorials/python.md#_4-registering-an-account), an [asset](/guide/tutorials/python.md#_5-registering-and-minting-assets) |
@@ -130,15 +130,15 @@ are assumed to be non-negative as well, so you can never have $-1.0$ of
130130
Refer to one of the language-specific guides to walk you through the
131131
process of minting assets in a blockchain:
132132

133-
- [CLI](/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets)
133+
- [CLI](/get-started/operate-iroha-2-via-cli.md#_6-register-and-mint-assets)
134134
- [Rust](/guide/tutorials/rust.md#_5-registering-and-minting-assets)
135135
- [Kotlin/Java](/guide/tutorials/kotlin-java.md#_5-registering-and-minting-assets)
136136
- [Python](/guide/tutorials/python.md#_5-registering-and-minting-assets)
137137
- [JavaScript/TypeScript ](/guide/tutorials/javascript.md#_5-registering-and-minting-assets)
138138

139139
Here are examples of burning assets:
140140

141-
- [CLI](/get-started/operate-iroha-via-cli.md#_8-burn-assets)
141+
- [CLI](/get-started/operate-iroha-2-via-cli.md#_8-burn-assets)
142142
- [Rust](/guide/tutorials/rust.md#_7-burning-assets)
143143

144144
## Transfer
@@ -147,9 +147,9 @@ Similar to mint and burn instructions, transferring refers to assets. You
147147
can transfer assets between different accounts.
148148

149149
To do this, an account have to be granted the
150-
[permission to transfer assets](/reference/permissions).
150+
[permission to transfer assets](/reference/permissions.md).
151151
Refer to an example on how to
152-
transfer assets with [CLI](/get-started/operate-iroha-via-cli.md#_7-transfer-assets) or [Rust](/guide/tutorials/rust.md#_6-transferring-assets).
152+
transfer assets with [CLI](/get-started/operate-iroha-2-via-cli.md#_7-transfer-assets) or [Rust](/guide/tutorials/rust.md#_6-transferring-assets).
153153

154154
<!--TODO: add links to transferring assets example in which guide after https://github.com/hyperledger/iroha-2-docs/issues/81 is addressed -->
155155

@@ -174,7 +174,7 @@ blockchain is a rather advanced topic that we shall cover separately.
174174

175175
With these instructions, you can create (`NewParameter`) and change
176176
(`SetParameter`) chain-wide
177-
[configuration parameters](/guide/configure/client-configuration) for
177+
[configuration parameters](/guide/configure/client-configuration.md) for
178178
Iroha.
179179

180180
## `ExecuteTrigger`

src/blockchain/metadata.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The metadata can be of very different types, such as:
2424
- request results
2525

2626
The object's metadata can be transferred one by one, or in bulk via a
27-
[WASM](/blockchain/wasm) transaction. The `Store` asset type is
27+
[WASM](/blockchain/wasm.md) transaction. The `Store` asset type is
2828
used for working with metadata. Let's take a closer look at this asset
2929
type.
3030

@@ -148,7 +148,7 @@ fn register_and_grant_role_for_metadata_access() -> Result<()> {
148148
## Queries
149149

150150
You can get the key value of an object metadata using
151-
[queries](/blockchain/queries):
151+
[queries](/blockchain/queries.md):
152152

153153
- [`FindAccountKeyValueByIdAndKey`](/reference/queries.md#findaccountkeyvaluebyidandkey)
154154
- [`FindAssetKeyValueByIdAndKey`](/reference/queries.md#findassetkeyvaluebyidandkey)
@@ -159,4 +159,4 @@ You can get the key value of an object metadata using
159159
## Permissions
160160

161161
Pre-configured tokens in Iroha 2 that allow to set or remove
162-
key-values in accounts, assets, asset definitions, and so on are described in [`Permissions`](/reference/permissions).
162+
key-values in accounts, assets, asset definitions, and so on are described in [`Permissions`](/reference/permissions.md).

src/blockchain/permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Before granting a role to an account, the role should be registered first.
7676
### Register a new role
7777

7878
Let's register a new role that, when granted, will allow another account
79-
access to the [metadata](/blockchain/metadata) in Mouse's account:
79+
access to the [metadata](/blockchain/metadata.md) in Mouse's account:
8080

8181
```rust
8282
let role_id = RoleId::from_str("ACCESS_TO_MOUSE_METADATA")?;

src/blockchain/queries.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,19 +77,19 @@ that match the specified filter.
7777

7878
## Sorting
7979

80-
Iroha 2 can sort items with [metadata](/blockchain/metadata)
80+
Iroha 2 can sort items with [metadata](/blockchain/metadata.md)
8181
lexicographically if you provide a key to sort by during the construction
8282
of the query. A typical use case is for accounts to have a `registered-on`
8383
metadata entry, which, when sorted, allows you to view the account
8484
registration history.
8585

8686
Sorting only applies to entities that have
87-
[metadata](/blockchain/metadata), as the metadata key is used to
87+
[metadata](/blockchain/metadata.md), as the metadata key is used to
8888
sort query results.
8989

9090
You can combine sorting with pagination and filters. Note that sorting is
9191
an optional feature, most queries with pagination won't need it.
9292

9393
## Reference
9494

95-
Check the [list of existing queries](/reference/queries) for detailed information about them.
95+
Check the [list of existing queries](/reference/queries.md) for detailed information about them.

0 commit comments

Comments
 (0)