Skip to content

Commit

Permalink
feat(docs): add tags check and refactor tags (#1657)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron authored Aug 12, 2024
1 parent 7fdff32 commit 63480cd
Show file tree
Hide file tree
Showing 106 changed files with 546 additions and 636 deletions.
5 changes: 4 additions & 1 deletion docs/content/developer/advanced/iota-repository.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
description: "A guide to familiarizing yourself with the IOTA repository, including branch and network structure."
tags: [ environment setup, repository ]
tags:
- explanation
- repository
- crates
---

# The IOTA Repository
Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/getting-started/connect.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Guide to connecting to an IOTA network for development and production.
tags: [ network, development, Mainnet, Testnet, Devnet ]
tags: [ explanation, mainnet, testnet, devnet, cli, setup, install, getting-started ]
---

import DataWipe from "../../_snippets/data-wipe.mdx";
Expand Down
5 changes: 4 additions & 1 deletion docs/content/developer/getting-started/get-address.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
description: Guide to creating an IOTA address for accounts and transactions.
tags: [ address, account, CLI, wallet]
tags:
- explanation
- cli
- address
---
# Create an Address

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/getting-started/get-coins.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Get test IOTA tokens using the IOTA CLI, SDK, or cURL.
tags: [test tokens, faucet, CLI, cURL, TypeScript SDK]
tags: [how-to, cli, typescript, sdk, faucet]
---

import AlphaNet from "../../_snippets/alphanet.mdx";
Expand Down
6 changes: 5 additions & 1 deletion docs/content/developer/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
description: An introduction to getting started with IOTA Rebased development.
tags: [ IOTA, blockchain, development, setup, installation ]
tags:
- explanation
- getting-started
- setup
- install
---

# Getting Started
Expand Down
9 changes: 8 additions & 1 deletion docs/content/developer/getting-started/iota-environment.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
description: "A guide to familiarizing yourself with the IOTA repository, branch and network structure, SDKs, CLI, and recommended IDEs and plugins."
tags: [ environment setup, repository, CLI, SDK, Move ]
tags:
- explanation
- setup
- cli
- sdk
- typescript
- rust
- move
---

# Before You Start
Expand Down
4 changes: 2 additions & 2 deletions docs/content/developer/getting-started/iota-install.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Install IOTA
description: Install the IOTA framework and required prerequisites on your system, including the IOTA command line interface to interact with the IOTA network.
tags: [ installation, setup, prerequisites, CLI ]
tags: [ how-to, cli, getting-started, install, setup ]
---

import MacosDeps from "../../_snippets/macos-deps.mdx";
import LinuxDeps from "../../_snippets/linux-deps.mdx";

In order to deploy your contracts and interact with the chains some tooling is required. IOTA Rebased has a excellent command-line tool that can be used for the most common tasks.
In order to deploy your contracts and interact with the chains some tooling is required. IOTA Rebased has an excellent command-line tool that can be used for the most common tasks.

The simplest way to get up and running with IOTA is to [install the binary](#install-from-binaries) from the latest
release available in the [IOTA Rebased GitHub Repository](https://github.com/iotaledger/iota/). Make sure to download
Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/getting-started/local-network.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Guide to setting up and using a local IOTA network for development and testing.
tags: [ local network, development, testing, CLI, wallet, ts, sdk]
tags: [ how-to, install, setup, cli, typescript, sdk, testing ]
---
# Local Development

Expand Down
6 changes: 2 additions & 4 deletions docs/content/developer/iota-evm/explanations/consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
description: IOTA Smart Contracts consensus is how Layer 2 validators agree to change the chain state in the same way.
image: /img/logo/WASP_logo_dark.png
tags:
- smart contracts
- consensus
- validator committee
- validators
- validator nodes
- validator
- explanation
- evm
---

# Consensus
Expand Down
8 changes: 2 additions & 6 deletions docs/content/developer/iota-evm/explanations/context.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
---
description: The call context is a predefined parameter to each smart contract function, which allows you to access the functionality that the call environment provides.
tags:
- WasmLib
- smart contract setup
- Func and View functions
- ScFuncContext
- ScViewContext
- Schema Tool
- explanation
- evm
image: /img/logo/WASP_logo_dark.png
---

Expand Down
12 changes: 3 additions & 9 deletions docs/content/developer/iota-evm/explanations/core-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: There currently are 6 core smart contracts that are always deployed on each chain, root, _default, accounts, blob, blocklog, and governance.
image: /img/banner/banner_wasp_core_contracts_overview.png
tags:
- smart contracts
- core
- initialization
- request handling
- on-chain ledger
- accounts
- data
- receipts
- reference
- core-contract
- reference
- evm
---

# Core Contracts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
---
description: 'IOTA Smart Contracts chains keep a ledger of on-chain account balances. On-chain accounts are identified
by an AgentID.'
description: IOTA Smart Contracts chains keep a ledger of on-chain account balances. On-chain accounts are identified by an AgentID.
image: /img/iota-evm/tutorial/accounts.png
tags:

- smart contracts
- on-chain account
- ownership
- accounts Contract
- explanation

- explanation
- isc-accounts
- evm
---

# How Accounts Work
Expand Down
16 changes: 5 additions & 11 deletions docs/content/developer/iota-evm/explanations/invocation.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
---
description: 'Smart contracts can be invoked through their entry points, from outside via a request, or from inside via a
call.'
description: Smart contracts can be invoked through their entry points, from outside via a request, or from inside via a call.
image: /img/logo/WASP_logo_dark.png
tags:

- smart contracts
- requests
- on-ledger
- off-ledger
- calls
- invocation
- explanation

- on-ledger
- off-ledger
- explanation
- evm
---

import OnOffLedgerRequest from '../../../_snippets/iota-evm/on_off_ledger_request.md';
Expand Down
12 changes: 3 additions & 9 deletions docs/content/developer/iota-evm/explanations/sandbox.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
---
description: 'Smart Contracts can only interact with the world by using the Sandbox interface which provides limited and
deterministic access to the state through a key/value storage abstraction.'
description: Smart Contracts can only interact with the world by using the Sandbox interface which provides limited and deterministic access to the state through a key/value storage abstraction.
image: /img/iota-evm/sandbox.png
tags:

- smart contracts
- sandbox
- interface
- storage abstraction
- explanation

- explanation
- evm
---

# Sandbox Interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@
description: Each smart contract instance has a program with a collection of entry points and a state.
image: /img/iota-evm/tutorial/SC-structure.png
tags:
- smart contracts
- structure
- state
- entry points
- Wasm
- explanation
- explanation
- evm
---

# Anatomy of a Smart Contract
Expand Down
12 changes: 3 additions & 9 deletions docs/content/developer/iota-evm/explanations/smart-contracts.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
---
description: 'Smart contracts are applications you can trust that run on a distributed network with multiple validators
all executing and validating the same code.'
description: Smart contracts are applications you can trust that run on a distributed network with multiple validators all executing and validating the same code.
image: /img/banner/banner_wasp_core_concepts_smart_contracts.png
tags:

- smart contracts
- blockchain
- parallel
- scaling
- explanation

- explanation
- evm
---

# Smart Contracts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
description: State manager is Wasp component, which is responsible for keeping the store up to date.
image: /img/logo/WASP_logo_dark.png
tags:
- state manager
- pruning
- snapshot
- write ahead log
- WAL
- evm
---

# State Manager
Expand Down
14 changes: 4 additions & 10 deletions docs/content/developer/iota-evm/explanations/states.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
---
description: 'The state of the chain consists of balances of native IOTA digital assets and a collection of key/value
pairs which represents use case-specific data stored in the chain by its smart contracts outside the UTXO ledger.'
description: The state of the chain consists of balances of native IOTA digital assets and a collection of key/value pairs which represents use case-specific data stored in the chain by its smart contracts outside the UTXO ledger.
image: /img/iota-evm/chain0.png
tags:

- state
- transitions
- balances
- digital assets
- UTXO
- transitions
- explanation
- explanation
- state
- evm
---

# State, Transitions, and State Anchoring
Expand Down
11 changes: 5 additions & 6 deletions docs/content/developer/iota-evm/explanations/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
description: Each chain is run by a network of validator nodes which run a consensus on the chain state update.
image: /img/logo/WASP_logo_dark.png
tags:
- validators
- validator nodes
- access nodes
- consensus
- state update
- explanation
- validator
- access-node
- consensus
- explanation
- evm
---

# Validators
Expand Down
11 changes: 3 additions & 8 deletions docs/content/developer/iota-evm/getting-started/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,9 @@
description: Compatibility between the ISC EVM layer and existing Ethereum smart contracts and tooling.
image: /img/logo/WASP_logo_dark.png
tags:
- smart contracts
- EVM
- Ethereum
- Solidity
- limitations
- compatibility
- fees
- reference
- evm
- solidity
- reference
---

# EVM Compatibility in IOTA Smart Contracts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
description: Compatibility between languages and different virtual machines.
image: /img/logo/WASP_logo_dark.png
tags:
- smart contracts
- EVM
- Ethereum
- Solidity
- limitations
- compatibility
- reference
- evm
- solidity
- reference
---

import EVMCompatibility from '../../../_snippets/iota-evm/EVM_compatibility.md';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: Networks and endpoints in the IOTA ecosystem.
tags:
- mainnet
- shimmer
- devnet
- EVM Testnet
- reference
- Endpoints
- mainnet
- testnet
- reference
- evm
---

import { AddToMetaMaskButton } from '@theme/AddToMetaMaskButton';
Expand Down
13 changes: 4 additions & 9 deletions docs/content/developer/iota-evm/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,10 @@
description: This guide will help you quickly get started with the EVM
image: /img/logo/WASP_logo_dark.png
tags:
- quickstart
- developer
- using
- EVM
- Ethereum
- Solidity
- metamask
- JSON
- RPC
- quickstart
- evm
- solidity
- rpc
---

import DeployAdmonition from '../../../_snippets/iota-evm/deploy_a_smart_contract.md';
Expand Down
20 changes: 6 additions & 14 deletions docs/content/developer/iota-evm/getting-started/tools.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
description: 'Existing EVM tooling is compatible and can be used directly with an IOTA Smart Contracts chain running EVM.
You can configure hardhat, metamask, remix, Ether.js and Web3.js among others.'
description: Existing EVM tooling is compatible and can be used directly with an IOTA Smart Contracts chain running EVM. You can configure hardhat, metamask, remix, Ether.js and Web3.js among others.
image: /img/logo/WASP_logo_dark.png
tags:

- smart contracts
- chain
- EVM
- Solidity
- tooling
- wasp-cli
- hardhat
- metamask
- JSON-RPC
- reference

- evm
- solidity
- cli
- rpc
- reference
---

import Tabs from '@theme/Tabs';
Expand Down
Loading

0 comments on commit 63480cd

Please sign in to comment.