Skip to content

Commit

Permalink
feat(devx): Add versioning. Switched to absolute imports everywhere, …
Browse files Browse the repository at this point in the history
…added a devnet docs folder, and a version switcher.
  • Loading branch information
lucas-tortora committed Dec 17, 2024
1 parent 5ede929 commit 04382ed
Show file tree
Hide file tree
Showing 379 changed files with 43,884 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/content/about-iota/iota-architecture/epochs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/epochs.json';
import {questions} from '@site/static/json/about-iota/iota-architecture/epochs.json';

# Epochs and Reconfiguration

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/iota-security.json';
import {questions} from '@site/static/json/about-iota/iota-architecture/iota-security.json';

# Security

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/protocol-upgrades.json';
import {questions} from '@site/static/json/about-iota/iota-architecture/protocol-upgrades.json';

# Protocol Upgrades

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import StakingPoolReqs from "../../_snippets/staking-pool-reqs.mdx";
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/staking-reward.json';
import {questions} from '@site/static/json/about-iota/iota-architecture/staking-reward.json';

# Staking and Rewards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/iota-architecture/transaction-lifecycle.json';
import {questions} from '@site/static/json/about-iota/iota-architecture/transaction-lifecycle.json';
import ThemedImage from '@theme/ThemedImage';

# Transaction Life Cycle
Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/gas-in-iota.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: An IOTA transaction must both pay for the computational cost of exe
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/gas-in-iota.json';
import {questions} from '@site/static/json/about-iota/tokenomics/gas-in-iota.json';

An IOTA transaction must both pay for the computational cost of execution and pay a deposit for storing the objects a transaction creates or mutates. Specifically, [IOTA Gas Pricing](gas-pricing.mdx) is such that any transaction pays the following gas fees:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/gas-pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IOTA Gas Pricing
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/gas-pricing.json';
import {questions} from '@site/static/json/about-iota/tokenomics/gas-pricing.json';

The IOTA gas-pricing mechanism achieves three outcomes: delivering low, predictable transaction fees, incentivizing validators to optimize their transaction processing operations, and preventing denial of service attacks.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/iota-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The native asset on IOTA is called IOTA.
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/iota-token.json';
import {questions} from '@site/static/json/about-iota/tokenomics/iota-token.json';

The native asset on IOTA is called IOTA.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/proof-of-stake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Proof of Stake
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/proof-of-stake.json';
import {questions} from '@site/static/json/about-iota/tokenomics/proof-of-stake.json';

The IOTA platform relies on delegated proof-of-stake (DPoS) to determine the set of validators that process transactions.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/staking-unstaking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Staking and unstaking IOTA with validators earns a percentage of re
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/staking-unstaking.json';
import {questions} from '@site/static/json/about-iota/tokenomics/staking-unstaking.json';

IOTA uses a Delegated-Proof-of-Stake (DPoS) system to secure and operate the network, meaning that the voting power of a validator in the network is determined by the amount of stake delegated to them by IOTA token holders. The more stake delegated to a validator, the more voting power they have. In exchange for processing transactions and performing consensus, validators earn rewards based on a given IOTA inflation rate. These rewards are then shared among stakers as staking rewards.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/tokenomics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: IOTA Tokenomics
---
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/tokenomics.json';
import {questions} from '@site/static/json/about-iota/tokenomics/tokenomics.json';
import ThemedImage from '@theme/ThemedImage';

The collective ideation that the term tokenomics encompasses includes a wide range of concepts that define the science and behavior of blockchain economies. In basic terms, tokenomics are the financial foundation of blockchains. Much the same way a building with a poor foundation is doomed to fail, a blockchain without a well-researched, extensively planned, and painstakingly implemented token economy eventually crumbles.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/about-iota/tokenomics/validators-staking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Validators and Staking Pools

import StakingPoolReqs from "../../_snippets/staking-pool-reqs.mdx";
import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/about-iota/tokenomics/validators-staking.json';
import {questions} from '@site/static/json/about-iota/tokenomics/validators-staking.json';

Each IOTA validator maintains its own staking pool to track the amount of stake and to compound staking rewards. Validator pools operate together with a time series of exchange rates that are computed at each epoch boundary. These exchange rates determine the amount of IOTA tokens that each past IOTA staker can withdraw in the future. Importantly, the exchange rates increase as more rewards are deposited into a staking pool and the longer an amount of IOTA is deposited in a staking pool, the more rewards it will accrue.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/evm-to-move/creating-nft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Creating an ERC-721-like NFT
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/developer/evm-to-move/creating-nft.json';
import {questions} from '@site/static/json/developer/evm-to-move/creating-nft.json';

## How this works in Solidity / EVM

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/evm-to-move/creating-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Creating an ERC-20-like token
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/developer/evm-to-move/creating-token.json';
import {questions} from '@site/static/json/developer/evm-to-move/creating-token.json';

## How this works in Solidity / EVM

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/evm-to-move/tooling-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Tooling and APIs
---

import Quiz from '@site/src/components/Quiz';
import {questions} from '../../../site/static/json/developer/evm-to-move/tooling-apis.json';
import {questions} from '@site/static/json/developer/evm-to-move/tooling-apis.json';

## Tooling for EVM/Solidity

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/iota-101/nft/marketplace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: A brief introduction to implementing NFT marketplace extension usin



import Marketplace from '../../../../examples/move/nft_marketplace/README.md';
import Marketplace from '@site/../examples/move/nft_marketplace/README.md';

# Marketplace Extension

Expand Down
2 changes: 1 addition & 1 deletion docs/content/operator/iota-full-node/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: Learn how to set up an IOTA Full Node using docker.
---
import Quiz from '@site/src/components/Quiz';
import questions from '/json/node-operators/iota-full-node/node-setup.json';
import Docker from './../../../../docker/fullnode/README.md';
import Docker from '@site/../../docker/fullnode/README.md';
import WarningAdvanced from './../../_snippets/warning-advanced-instructions-node-setup.mdx'
import NodeHardwareRequirements from './../../_snippets/node-hardware-requirements.mdx'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_label: Ansible Configuration
---

import Configuration from './../../../../../nre/ansible/README.md';
import Configuration from '@site/../../nre/ansible/README.md';


# Ansible Configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Docker Configuration
---
import Configuration from './../../../../../nre/docker/README.md';
import Configuration from '@site/../../nre/docker/README.md';

# System Configuration

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Systemd Configuration
---
import Configuration from './../../../../../nre/systemd/README.md';
import Configuration from '@site/../../nre/systemd/README.md';

# System Configuration

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import ValidatorTasks from './../../../../nre/validator_tasks.md';
import ValidatorTasks from '@site/../../nre/validator_tasks.md';
import Quiz from '@site/src/components/Quiz';
import questions from '/json/node-operators/validator-tasks.json';

Expand Down
2 changes: 1 addition & 1 deletion docs/content/operator/validator-tools.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import ValidatorTools from './../../../nre/validator_tool.md';
import ValidatorTools from '@site/../../nre/validator_tool.md';
import Quiz from '@site/src/components/Quiz';
import questions from '/json/node-operators/validator-tools.json';

Expand Down
2 changes: 1 addition & 1 deletion docs/content/references/rust-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IOTA Rust SDK
description: The IOTA Rust SDK provides Rust wrappers around the IOTA API. Using the SDK, you can interact with IOTA networks using the Rust programming language.
---

import README from "../../../crates/iota-sdk/README.md";
import README from "@site/../../crates/iota-sdk/README.md";

The IOTA Rust SDK crate is in the [**crates\iota-sdk** directory](https://github.com/iotaledger/iota/tree/develop/crates/iota-sdk) of the IOTA repository.

Expand Down
31 changes: 31 additions & 0 deletions docs/site/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,21 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
lastVersion: 'current',
versions: {
current: {
label: 'Testnet',
path: '/',
badge: true,
banner: 'none',
},
devnet: {
label: 'Devnet',
path: 'devnet',
badge: true,
banner: 'none',
},
},
path: "../content",
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
Expand Down Expand Up @@ -240,28 +255,44 @@ const config = {
},
items: [
{
type: 'docsVersion',
label: "About IOTA",
to: "about-iota",
activeBaseRegex: 'about-iota[/]{0,1}.*',
},
{
type: 'docsVersion',
label: "Developers",
to: "developer",
activeBaseRegex: 'developer[/]{0,1}.*',
},
{
type: 'docsVersion',
label: "Node Operators",
to: "operator",
activeBaseRegex: 'operator[/]{0,1}.*',
},
{
type: 'docsVersion',
label: "References",
to: "references",
activeBaseRegex: 'references[/]{0,1}(?!.*(ts-sdk))',
},
{
type: 'docsVersion',
label: "TS SDK",
to: "references/ts-sdk/typescript/",
activeBaseRegex: 'ts-sdk[/]{0,1}.*',
},
{
type: 'docsVersion',
label: "IOTA Identity",
to: "iota-identity",
activeBaseRegex: 'iota-identity[/]{0,1}.*',
},
{
type: 'docsVersionDropdown',
position: 'right',
},
],
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
You can pass literal addresses and objects IDs by prefixing them with '@'. This is needed to distinguish a hexadecimal value from an address in some situations.

For addresses that are in your local wallet, you can use their alias instead (passing them without '@', for example, --transfer-objects my_alias).
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::info

You can view the [complete source code for this app example](https://github.com/iotaledger/iota/tree/develop/examples/trading) in the IOTA repository.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:::tip Automated Address Management

IOTA supports [Automated Address Management](../developer/iota-101/move-overview/package-upgrades/automated-address-management.mdx),
with which addresses will automatically be updated in the `Move.lock` file.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Check IOTA CLI installation

Before you can use the IOTA CLI, you must install it. To check if the CLI exists on your system, open a terminal or console and type the following command:

```shell
iota --version
```

If the terminal or console responds with a version number, you already have the IOTA CLI installed.

If the command is not found, follow the instructions in [Install IOTA](/developer/getting-started/install-iota.mdx) to get the IOTA CLI on your system.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

:::danger Data persistence is not guaranteed on the Testnet and Devnet

Devnet data is wiped regularly as part of scheduled software updates.

The data on Testnet persists through the regular update process, but might be wiped when necessary. Testnet data wipes are announced ahead of time.

:::
6 changes: 6 additions & 0 deletions docs/site/versioned_docs/version-devnet/_snippets/faucet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:::info

Faucets on Devnet and Testnet are rate limited. If you run the script too many times, you
surpass the limit and must wait to successfully run it again.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:::info

It is suggested to use dedicated nodes/shared services rather than public endpoints for production apps with high traffic volume.

You can either run your own Full nodes, or outsource this to a professional infrastructure provider (preferred for apps that have high traffic).

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::info

You must use the pnpm or yarn package managers to create IOTA project scaffolds. Follow the [pnpm install](https://pnpm.io/installation) or [yarn install](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) instructions, if needed.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:::info

See [Publish a Package](../developer/getting-started/publish.mdx) for a more detailed guide on publishing packages or [IOTA Client CLI](/references/cli/client.mdx) for a complete reference of `client` commands in the IOTA CLI.

:::

Before publishing your code, you must first initialize the IOTA Client CLI, if you haven't already. To do so, in a terminal or console at the root directory of the project enter `iota client`. If you receive the following response, complete the remaining instructions:

```
Config file ["<FILE-PATH>/.iota/iota_config/client.yaml"] doesn't exist, do you want to connect to a IOTA Full node server [y/N]?
```

Enter `y` to proceed. You receive the following response:

```
IOTA Full node server URL (Defaults to IOTA Devnet if not specified) :
```

Leave this blank (press Enter). You receive the following response:

```
Select key scheme to generate keypair (0 for ed25519, 1 for secp256k1, 2: for secp256r1):
```

Select `0`. Now you should have a IOTA address set up.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:::note Required Prior Knowledge

This guide assumes you are familiar with the concept
of [tokens](https://en.wikipedia.org/wiki/Cryptocurrency#Crypto_token)
in [blockchain](https://en.wikipedia.org/wiki/Blockchain),
[Ethereum Request for Comments (ERCs)](https://eips.ethereum.org/erc)(also known as Ethereum Improvement Proposals (
EIP))
, NFTs, Smart Contracts
and have already tinkered with [Solidity](https://docs.soliditylang.org/en/v0.8.16/).

You should also have basic knowledge on how to [create](../../developer/iota-evm/how-tos/create-a-basic-contract.mdx) and [deploy](../../developer/iota-evm/how-tos/deploy-a-smart-contract.mdx)
a smart contract.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:::info EVM Compatibility

The ISC EVM layer is also designed to be as compatible as possible with existing Ethereum
[tools](../../developer/iota-evm/getting-started/tools.mdx) and functionalities. However, please make sure you have checked out the current
[properties and limitations](../../developer/iota-evm/getting-started/compatibility.md).

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::info Accounts in ISC

Learn more about the [different types of accounts](../../developer/iota-evm/explanations/how-accounts-work.md).

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::tip Deploy a Smart Contract

Deploy a Solidity Smart Contract following our [how to Deploy a Smart Contract guide](../../developer/iota-evm/how-tos/deploy-a-smart-contract.mdx).

:::
Loading

0 comments on commit 04382ed

Please sign in to comment.