Skip to content

Commit

Permalink
Getting started update and overhaul
Browse files Browse the repository at this point in the history
  • Loading branch information
a-zorina committed Jul 17, 2024
1 parent c1520e4 commit fd193ab
Show file tree
Hide file tree
Showing 21 changed files with 624 additions and 912 deletions.
39 changes: 13 additions & 26 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ function nav(): DefaultTheme.NavItem[] {
text: 'Guide',
items: [
// { text: 'Get Started', link: '/guide/get-started/index' },
// { text: 'Build and Install', link: '/guide/get-started/install' },
// { text: 'Build and Install', link: '/guide/get-started/install-iroha' },
// { text: 'Tutorials', link: '/guide/get-started/tutorials'},
{
text: 'Get Started',
items: [
{ text: 'Build and Install', link: '/guide/get-started/install' },
{ text: 'Install and Build', link: '/guide/get-started/install-iroha' },
{ text: 'SDK Tutorials', link: '/guide/get-started/tutorials' },
],
},
Expand Down Expand Up @@ -93,32 +93,23 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
return [
{
text: 'Get Started',
link: '/guide/get-started/',
items: [
{
text: 'About Iroha',
link: '/guide/introduction',
text: 'Install Iroha',
link: '/guide/get-started/install-iroha',
},
{
text: 'Iroha 2 vs. Iroha 1',
link: '/guide/iroha-2',
text: 'Launch Iroha',
link: '/guide/get-started/launch-iroha',
},
{
text: 'Build and Install',
collapsed: true,
items: [
{
text: 'Install Iroha',
link: '/guide/get-started/install',
},
{
text: 'Build Iroha Client',
link: '/guide/get-started/build',
},
{
text: 'Quick Start with Docker',
link: '/guide/get-started/quick-start',
},
],
text: 'Operate Iroha via CLI',
link: '/guide/get-started/operate-iroha-via-cli',
},
{
text: 'Iroha 2 vs. Iroha 1',
link: '/guide/iroha-2',
},
{
text: 'Receive support',
Expand Down Expand Up @@ -174,10 +165,6 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
{
text: 'Language-specific Guides',
items: [
{
text: 'Bash',
link: '/guide/get-started/bash',
},
{
text: 'Python 3',
link: '/guide/get-started/python',
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Hyperledger Iroha 2 Tutorial

This repository contains the source files for [Hyperledger Iroha 2 Tutorial](https://hyperledger.github.io/iroha-2-docs/).
This repository contains the source files for [Hyperledger Iroha 2 Documentation](https://hyperledger.github.io/iroha-2-docs/).

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:

- [Bash](https://hyperledger.github.io/iroha-2-docs/guide/bash.html)
- [CLI](https://hyperledger.github.io/iroha-2-docs/guide/operate-iroha-via-cli.html)
- [Python](https://hyperledger.github.io/iroha-2-docs/guide/python.html)
- [Rust](https://hyperledger.github.io/iroha-2-docs/guide/rust.html)
- [Kotlin/Java](https://hyperledger.github.io/iroha-2-docs/guide/kotlin-java.html)
Expand Down
5 changes: 2 additions & 3 deletions src/guide/advanced/running-iroha-on-bare-metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,9 +353,8 @@ ports need to be adjusted so there are no collisions. See the

## Deploy a minimal BFT network

Both of the following approaches could be messy and error-prone, which is why the [Quick Start](../get-started/quick-start.md) tutorial suggests using the `docker compose` command.
However, this brings you closer to the
experience of actually maintaining a functional Iroha peer.
Both of the following approaches could be messy and error-prone, which is why the [Launch Iroha](../get-started/launch-iroha.md) tutorial suggests using the `docker compose` command.
However, this brings you closer to the experience of actually maintaining a functional Iroha peer.

### Using Environment Variables

Expand Down
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:

- [Bash](/guide/get-started/bash.md#_5-registering-and-minting-assets)
- [CLI](/guide/get-started/operate-iroha-via-cli.md#_6-registering-and-minting-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 |
| --------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Bash | Register a [domain](/guide/get-started/bash.md#_3-registering-a-domain), an [account](/guide/get-started/bash.md#_4-registering-an-account), an [asset](/guide/get-started/bash.md#_5-registering-and-minting-assets) |
| 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) |
| 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
2 changes: 1 addition & 1 deletion src/guide/blockchain/how-iroha-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To understand how Iroha operates, let's draw parallels between a blockchain
and a computer. If the blockchain is the computer, then in this metaphor of
ours the client binary (for example: [`iroha_client_cli`](/guide/get-started/bash.md))
ours the client binary (for example: [`iroha_client_cli`](/guide/get-started/operate-iroha-via-cli.md))
is the keyboard, the blockchain is the hard drive, and the Iroha peer
software is the processor. Like a processor, Iroha accepts portable
instructions that modify what's written to the blockchain, allow certain
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 |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Bash | Register a [domain](/guide/get-started/bash.md#_3-registering-a-domain), an [account](/guide/get-started/bash.md#_4-registering-an-account), an [asset](/guide/get-started/bash.md#_5-registering-and-minting-assets) |
| 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) |
| 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:

- [Bash](/guide/get-started/bash.md#_5-registering-and-minting-assets)
- [CLI](/guide/get-started/operate-iroha-via-cli.md#_6-registering-and-minting-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:

- [Bash](/guide/get-started/bash.md#_7-burning-assets)
- [CLI](/guide/get-started/operate-iroha-via-cli.md#_8-burning-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 in [Bash](/guide/get-started/bash.md#_6-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-transferring-assets) or [Rust](/guide/get-started/rust.md#_7-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
Loading

0 comments on commit fd193ab

Please sign in to comment.