Skip to content

Commit

Permalink
Language and structure improvements
Browse files Browse the repository at this point in the history
Signed-off-by: a-zorina <[email protected]>
  • Loading branch information
a-zorina committed Jul 24, 2024
1 parent 3151b5a commit 4fa6fef
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 91 deletions.
2 changes: 1 addition & 1 deletion src/guide/blockchain/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Assets can be [registered](./instructions.md#un-register),
Refer to one of the language-specific guides to walk you through the
process of registering and minting assets in a blockchain:

- [CLI](/guide/get-started/operate-iroha-via-cli.md#_6-registering-and-minting-assets)
- [CLI](/guide/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets)
- [Rust](/guide/get-started/rust.md#_5-registering-and-minting-assets)
- [Kotlin/Java](/guide/get-started/kotlin-java.md#_5-registering-and-minting-assets)
- [Python](/guide/get-started/python.md#_5-registering-and-minting-assets)
Expand Down
2 changes: 1 addition & 1 deletion src/guide/blockchain/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ domain_looking_glass *-- account_rabbit : registered in

| Language | Guide |
| --------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CLI | Register a [domain](/guide/get-started/operate-iroha-via-cli.md#_3-registering-a-domain), an [account](/guide/get-started/operate-iroha-via-cli.md#_4-registering-an-account), an [asset](/guide/get-started/operate-iroha-via-cli.md#_6-registering-and-minting-assets) |
| CLI | Register a [domain](/guide/get-started/operate-iroha-via-cli.md#_3-register-a-domain), an [account](/guide/get-started/operate-iroha-via-cli.md#_4-register-an-account), an [asset](/guide/get-started/operate-iroha-via-cli.md#_6-register-and-mint-assets) |
| Rust | Register a [domain](/guide/get-started/rust.md#_3-registering-a-domain), an [account](/guide/get-started/rust.md#_4-registering-an-account), an [asset](/guide/get-started/rust.md#_5-registering-and-minting-assets) |
| Kotlin/Java | Register a [domain](/guide/get-started/kotlin-java.md#_3-querying-and-registering-domains), an [account](/guide/get-started/kotlin-java.md#_4-registering-an-account), an [asset](/guide/get-started/kotlin-java.md#_5-registering-and-minting-assets) |
| Python | Register a [domain](/guide/get-started/python.md#_3-registering-a-domain), an [account](/guide/get-started/python.md#_4-registering-an-account), an [asset](/guide/get-started/python.md#_5-registering-and-minting-assets) |
Expand Down
8 changes: 4 additions & 4 deletions src/guide/blockchain/instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ process of registering objects in a blockchain:

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

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

Here are examples of burning assets:

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

## Transfer
Expand All @@ -149,7 +149,7 @@ can transfer assets between different accounts.
To do this, an account have to be granted the
[permission to transfer assets](/reference/permissions.md).
Refer to an example on how to
transfer assets with [CLI](/guide/get-started/operate-iroha-via-cli.md#_7-transferring-assets) or [Rust](/guide/get-started/rust.md#_6-transferring-assets).
transfer assets with [CLI](/guide/get-started/operate-iroha-via-cli.md#_7-transfer-assets) or [Rust](/guide/get-started/rust.md#_6-transferring-assets).

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

Expand Down
8 changes: 4 additions & 4 deletions src/guide/get-started/install-iroha.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You will be guided through the setup process. Just go with the defaults.
<!-- TODO: change recommended installation method to docker binaries/cargo install -->


1. If you haven’t already, you might want to create a clean folder for
1. If you haven’t already, you might want to create a clean directory for
Iroha 2, to keep things tidy.

```bash
Expand All @@ -61,8 +61,8 @@ You will be guided through the setup process. Just go with the defaults.

On macOS, if you get
`fatal: could not create work tree dir 'iroha': Read-only file system`,
that’s because the home folder is not a real file system. The fix is to
create the `Git` folder.
that’s because the home directory is not a real file system. The fix is to
create the `Git` directory.

:::

Expand All @@ -72,7 +72,7 @@ You will be guided through the setup process. Just go with the defaults.
$ cd ~/Git
```

3. Then `clone` the Iroha git repository into the folder `~/Git/iroha`
3. Then `clone` the Iroha git repository into the directory `~/Git/iroha`

```bash
$ git clone https://github.com/hyperledger/iroha.git
Expand Down
Loading

0 comments on commit 4fa6fef

Please sign in to comment.