From f90c1e07bae5c2646774ad92d43fbc458d55be2a Mon Sep 17 00:00:00 2001 From: Raz Landau <125185051+LandauRaz@users.noreply.github.com> Date: Mon, 16 Dec 2024 11:42:14 +0200 Subject: [PATCH] restructed nav (#1453) --- components/Starknet/antora.yml | 13 ++-- .../Starknet/modules/ROOT/nav_glossary.adoc | 24 +++++++ .../Starknet/modules/quick-start/nav.adoc | 27 ++------ components/Starknet/modules/tools/nav.adoc | 69 +++++-------------- 4 files changed, 55 insertions(+), 78 deletions(-) diff --git a/components/Starknet/antora.yml b/components/Starknet/antora.yml index 8bc94f297b..6c59c9e632 100644 --- a/components/Starknet/antora.yml +++ b/components/Starknet/antora.yml @@ -2,10 +2,9 @@ name: ROOT version: ~ title: Starknet nav: - - modules/ROOT/nav.adoc # Home - - modules/quick-start/nav.adoc # Quick start - - modules/starknet-versions/nav.adoc # What is Starknet (temporary landing page) - - modules/architecture-and-concepts/nav.adoc # Architecture and concepts - - modules/cli/nav.adoc # Starknet CLI - - modules/tools/nav.adoc # Developer tools and resources - - modules/ROOT/nav_glossary.adoc # The glossary \ No newline at end of file + - modules/ROOT/nav.adoc + - modules/quick-start/nav.adoc + - modules/architecture-and-concepts/nav.adoc + - modules/tools/nav.adoc + - modules/starknet-versions/nav.adoc + - modules/ROOT/nav_glossary.adoc \ No newline at end of file diff --git a/components/Starknet/modules/ROOT/nav_glossary.adoc b/components/Starknet/modules/ROOT/nav_glossary.adoc index 7c2eb1c886..98ca44f891 100644 --- a/components/Starknet/modules/ROOT/nav_glossary.adoc +++ b/components/Starknet/modules/ROOT/nav_glossary.adoc @@ -1 +1,25 @@ +* StarkGate guide + ** xref:starkgate:overview.adoc[Overview] + ** xref:starkgate:architecture.adoc[Architecture] + ** Procedures + *** xref:starkgate:depositing.adoc[Depositing funds] + *** xref:starkgate:withdrawing.adoc[Withdrawing funds] + *** xref:starkgate:automated-actions-with-bridging.adoc[Performing a Smart Deposit] + *** xref:starkgate:adding-a-token.adoc[Adding a token] + *** xref:starkgate:cancelling-a-deposit.adoc[Cancelling a deposit] + *** xref:starkgate:estimating-fees.adoc[Estimating StarkGate fees] + *** xref:starkgate:dai-token-migration.adoc[Migrating DAI v0 to DAI] + ** xref:starkgate:function-reference.adoc[Function and event reference] +* Staking guide + ** xref:staking:overview.adoc[Overview] + ** xref:staking:architecture.adoc[Architecture] + ** Procedures + *** xref:staking:entering-staking.adoc[Becoming a validator] + *** xref:staking:increasing-staking.adoc[Increasing stake] + *** xref:staking:claiming-rewards.adoc[Claiming rewards] + *** xref:staking:delegating-stake.adoc[Delegating stake] + *** xref:staking:switching-delegation-pools.adoc[Switching delegation pools] + *** xref:staking:exiting-staking.adoc[Exiting the staking protocol] + *** xref:staking:managing-staking-and-delegation-operations.adoc[Managing staking and delegation operations] + *** xref:staking:staking-events-and-read-functions.adoc[Using staking events and read functions] * xref:glossary.adoc[] \ No newline at end of file diff --git a/components/Starknet/modules/quick-start/nav.adoc b/components/Starknet/modules/quick-start/nav.adoc index 57f31a4df9..fa7acee1fe 100644 --- a/components/Starknet/modules/quick-start/nav.adoc +++ b/components/Starknet/modules/quick-start/nav.adoc @@ -1,20 +1,7 @@ -* Quick start - -** xref:environment-setup.adoc[Setting up your environment] -// *** xref:environment-setup.adoc#installing_starkli[Installing Starkli] -// *** xref:environment-setup.adoc#setting_environment_variables_for_starkli[Environment variables] -// *** xref:environment-setup.adoc#installing_scarb[Installing Scarb] - -** xref:set-up-an-account.adoc[Setting up an account] -// *** xref:set-up-an-account.adoc#creating_an_account[Creating an account] -// *** xref:set-up-an-account.adoc#deploying_an_account[Deploying an account] - -** xref:declare-a-smart-contract.adoc[Declaring a smart contract] - -** xref:deploy-a-smart-contract.adoc[Deploying a smart contract] - -** xref:interact-with-a-smart-contract.adoc[Interacting with a smart contract] - -** xref:using_devnet.adoc[] - -// ** xref:deploy-interact-with-a-smart-contract-remix.adoc[Deploying and interacting with a smart contract with Remix] +* Quickstart + ** xref:environment-setup.adoc[Setting up your environment] + ** xref:set-up-an-account.adoc[Setting up an account] + ** xref:declare-a-smart-contract.adoc[Declaring a smart contract] + ** xref:deploy-a-smart-contract.adoc[Deploying a smart contract] + ** xref:interact-with-a-smart-contract.adoc[Interacting with a smart contract] + ** xref:using_devnet.adoc[] \ No newline at end of file diff --git a/components/Starknet/modules/tools/nav.adoc b/components/Starknet/modules/tools/nav.adoc index 355eb0de0b..fd5a19eb49 100644 --- a/components/Starknet/modules/tools/nav.adoc +++ b/components/Starknet/modules/tools/nav.adoc @@ -1,51 +1,18 @@ -* Tools and resources - -** Developer Tools -*** xref:devtools/overview.adoc[Overview] -*** xref:devtools/clis.adoc[Command Line Tools] -*** xref:devtools/sdks.adoc[Software Development Kits] -*** xref:devtools/smart-contract-tools.adoc[Smart Contract Development] -*** xref:devtools/vscode.adoc[Visual Studio Code Extension] -*** xref:devtools/devnets.adoc[Local Development Nodes] -*** xref:devtools/libs-for-dapps.adoc[Libraries for Dapps] -*** xref:devtools/dapp-frameworks.adoc[Dapp Frameworks] -*** xref:devtools/utilities.adoc[Utilities] -*** xref:devtools/security.adoc[Security Tools] - -** xref:api-services.adoc[Full nodes and API services] - -** xref:ref-block-explorers.adoc[Block explorers] - -** xref:oracles.adoc[Oracles] - -** xref:data-indexers.adoc[Data indexers] - -** xref:audit.adoc[Audit providers] - -** xref:compatibility.adoc[Compatibility tables] - -* StarkGate guide -** xref:starkgate:overview.adoc[Overview] -** xref:starkgate:architecture.adoc[StarkGate architecture] -** Procedures -*** xref:starkgate:depositing.adoc[Depositing funds] -*** xref:starkgate:withdrawing.adoc[Withdrawing funds] -*** xref:starkgate:automated-actions-with-bridging.adoc[Performing a Smart Deposit] -*** xref:starkgate:adding-a-token.adoc[Adding a token] -*** xref:starkgate:cancelling-a-deposit.adoc[Cancelling a deposit] -*** xref:starkgate:estimating-fees.adoc[Estimating StarkGate fees] -*** xref:dai-token-migration.adoc[Migrating DAI v0 to DAI] -** xref:starkgate:function-reference.adoc[StarkGate function and event reference] - -* Staking guide -** xref:staking:overview.adoc[Overview] -** xref:staking:architecture.adoc[Staking Architecture] -** Procedures -*** xref:staking:entering-staking.adoc[Becoming a Validator] -*** xref:staking:increasing-staking.adoc[Increasing Stake] -*** xref:staking:claiming-rewards.adoc[Claiming Rewards] -*** xref:staking:delegating-stake.adoc[Delegating Stake] -*** xref:staking:switching-delegation-pools.adoc[Switching Delegation Pools] -*** xref:staking:exiting-staking.adoc[Exiting the Staking Protocol] -*** xref:staking:managing-staking-and-delegation-operations.adoc[Managing Staking and Delegation Operations] -*** xref:staking:staking-events-and-read-functions.adoc[Staking Events and Read Functions] +* Tooling + ** Developer Tools + *** xref:devtools/overview.adoc[Overview] + *** xref:devtools/clis.adoc[Command Line Tools] + *** xref:devtools/sdks.adoc[Software Development Kits] + *** xref:devtools/smart-contract-tools.adoc[Smart Contract Development] + *** xref:devtools/vscode.adoc[Visual Studio Code Extension] + *** xref:devtools/devnets.adoc[Local Development Nodes] + *** xref:devtools/libs-for-dapps.adoc[Libraries for Dapps] + *** xref:devtools/dapp-frameworks.adoc[Dapp Frameworks] + *** xref:devtools/utilities.adoc[Utilities] + *** xref:devtools/security.adoc[Security Tools] + ** xref:api-services.adoc[Full nodes and API services] + ** xref:ref-block-explorers.adoc[Block explorers] + ** xref:oracles.adoc[Oracles] + ** xref:data-indexers.adoc[Data indexers] + ** xref:audit.adoc[Audit providers] + ** xref:compatibility.adoc[Compatibility tables] \ No newline at end of file