Skip to content

Commit

Permalink
restructed nav (#1453)
Browse files Browse the repository at this point in the history
  • Loading branch information
LandauRaz authored Dec 16, 2024
1 parent b04863c commit f90c1e0
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 78 deletions.
13 changes: 6 additions & 7 deletions components/Starknet/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- 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
24 changes: 24 additions & 0 deletions components/Starknet/modules/ROOT/nav_glossary.adoc
Original file line number Diff line number Diff line change
@@ -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[]
27 changes: 7 additions & 20 deletions components/Starknet/modules/quick-start/nav.adoc
Original file line number Diff line number Diff line change
@@ -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[]
69 changes: 18 additions & 51 deletions components/Starknet/modules/tools/nav.adoc
Original file line number Diff line number Diff line change
@@ -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]

0 comments on commit f90c1e0

Please sign in to comment.