Skip to content

Commit

Permalink
Deploy new nav (#742)
Browse files Browse the repository at this point in the history
* Update introduction.adoc (#734)

* Update introduction.adoc (#733)

Co-authored-by: JameStark <[email protected]>

* docs: docs 2.0 (#617)

Docs nav restructure

---------

Co-authored-by: Steve Goodman <[email protected]>
  • Loading branch information
JameStark and stoobie authored Aug 15, 2023
1 parent e764a5e commit ffdcfe6
Show file tree
Hide file tree
Showing 71 changed files with 1,273 additions and 1,328 deletions.
14 changes: 8 additions & 6 deletions components/Starknet/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ name: documentation
version: ~
title: Starknet
nav:
- modules/ROOT/nav.adoc # What is Starknet (temporary landing page)
- 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 # Developing on Starknet
- modules/getting_started/nav.adoc # Hello Starknet tutorial
- modules/tools/nav.adoc # Network tools
- modules/useful_info/nav.adoc # Useful Info
- modules/end_of_life_and_deprecated_features/nav.adoc # eol
- modules/architecture_and_concepts/nav.adoc # Architecture and concepts
- modules/cairo/nav.adoc # Smart contract reference
- modules/cli/nav.adoc # Starknet CLI
# - modules/api/nav.adoc # API reference
- modules/tools/nav.adoc # Developer tools and resources
# - modules/contribute/nav.adoc # Contribute
2 changes: 1 addition & 1 deletion components/Starknet/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="overview"]
= Introduction
= Overview

Starknet is a permissionless decentralized Validity-Rollup (also known as a _ZK-Rollup_). It operates as an L2 network over Ethereum, enabling any dApp to achieve unlimited scale for its computation – without compromising Ethereum’s composability and security – thanks to Starknet’s reliance on the safest and most scalable cryptographic proof system: STARK.

Expand Down
2 changes: 2 additions & 0 deletions components/Starknet/modules/api/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* API reference
** xref:api-reference.adoc[Starknet API reference]
14 changes: 14 additions & 0 deletions components/Starknet/modules/api/pages/api-reference.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Starknet API reference


[subs="html"]
----
<div id="jsonContainer"></div>
----


// Todo: https://github.com/open-rpc/playground integrate the OpenRPC playground into the docs site

// Source files
// https://github.com/starkware-libs/starknet-specs/blob/master/api/starknet_trace_api_openrpc.json
// https://github.com/starkware-libs/starknet-specs/blob/master/api/starknet_write_api.json
78 changes: 41 additions & 37 deletions components/Starknet/modules/architecture_and_concepts/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
* Architecture and concepts
** Starknet accounts
*** xref:Account_Abstraction/introduction.adoc[Introduction to account abstraction]
*** xref:Account_Abstraction/approach.adoc[Starknet account structure]
*** xref:Account_Abstraction/validate_and_execute.adoc[Validate and execute]
*** xref:Account_Abstraction/deploying_new_accounts.adoc[Deploying new accounts]
*** xref:Account_Abstraction/simplified_transaction_flow.adoc[Simplified transaction flow]
** Smart contracts
*** xref:Contracts/contract-classes.adoc[Contract classes]
*** xref:Contracts/contract-address.adoc[Contract address]
*** xref:Contracts/contract-storage.adoc[Contract storage]
*** xref:Contracts/contract-abi.adoc[Contract ABI]
** Blocks and transactions
*** xref:Blocks/header.adoc[Block structure]
*** xref:Blocks/transaction-life-cycle.adoc[Transaction lifecycle]
*** xref:Blocks/transactions.adoc[Transaction types]

** xref:Fees/fee-mechanism.adoc[Gas and transaction fees]
** xref:L1-L2_Communication/token-bridge.adoc[Starkgate bridge]
** xref:L1-L2_Communication/messaging-mechanism.adoc[L1-L2 messaging]
** xref:Events/starknet-events.adoc[Events]
** xref:Data_Availability/on-chain-data.adoc[Data availability]
** xref:State/starknet-state.adoc[Starknet state]
** xref:Contracts/class-hash.adoc[Class hash]
** xref:Hashing/hash-functions.adoc[Hash functions]

** System Calls
*** xref:Contracts/system-calls-cairo1.adoc[Cairo 1.0]
*** xref:Contracts/system-calls-cairo0.adoc[Cairo 0]


** Cairo on Starknet
*** xref:Cairo_on_Starknet/cairo-1-and-sierra.adoc[Cairo 1.0 and Sierra]
*** xref:Cairo_on_Starknet/contract-syntax.adoc[Contract Syntax - Migration Guide]
* Architecture
** Blockchain architecture

*** Blocks and transactions
**** xref:Network_Architecture/Blocks/header.adoc[Block structure]
**** xref:Network_Architecture/Blocks/transaction-life-cycle.adoc[Transaction lifecycle]
**** xref:Network_Architecture/Blocks/transactions.adoc[Transaction types]
**** xref:Network_Architecture/Fees/fee-mechanism.adoc[Gas and transaction fees]

*** State
**** xref:Network_Architecture/State/starknet-state.adoc[Starknet state]
**** xref:Network_Architecture/Data_Availability/on-chain-data.adoc[Data availability]

*** L1-L2 messaging
**** xref:Network_Architecture/L1-L2_Communication/messaging-mechanism.adoc[L1-L2 messaging]
**** xref:Network_Architecture/L1-L2_Communication/token-bridge.adoc[Starkgate bridge]

** Accounts
*** xref:Accounts/introduction.adoc[Introduction to account abstraction]
*** xref:Accounts/approach.adoc[Starknet account structure]
*** xref:Accounts/validate_and_execute.adoc[Validate and execute]
*** xref:Accounts/deploying_new_accounts.adoc[Deploying new accounts]
*** xref:Accounts/simplified_transaction_flow.adoc[Simplified transaction flow]
** Contracts
*** xref:Smart_Contracts/contract-classes.adoc[Contract classes]
*** xref:Smart_Contracts/class-hash.adoc[Class hash]
*** xref:Smart_Contracts/contract-address.adoc[Contract address]
*** xref:Smart_Contracts/contract-storage.adoc[Contract storage]
*** xref:Smart_Contracts/contract-abi.adoc[Contract ABI]
*** xref:Smart_Contracts/Events/starknet-events.adoc[Events]
*** xref:Smart_Contracts/contract-syntax.adoc[Contract migration guide]
*** xref:Smart_Contracts/cairo-and-sierra.adoc[Cairo and Sierra]
*** xref:Smart_Contracts/system-calls-cairo1.adoc[System calls]

** Cryptography
*** xref:Cryptography/p-value.adoc[Field element type]
*** xref:Cryptography/hash-functions.adoc[Hash functions]
*** xref:Cryptography/stark-curve.adoc[Stark curve]
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="what_is_an_account"]
= What is an account?

An account is a user's representation on-chain and the way of interacting with the blockchain.
An account represents a user on-chain, and enables that user to interact with the blockchain.

Through an account, you may send transactions and interact with other contracts. To "own" an on-chain asset (e.g. ERC20 token or an NFT), it has to be associated with your account address.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ The key stages of transaction lifetime are:

The sequencer receives fees in ETH in return for including transactions in a block.

For more details on how the transaction fee is computed, see xref:Fees/fee-mechanism.adoc[the fees section]
For more details on how the transaction fee is computed, see xref:../Network_Architecture/Fees/fee-mechanism.adoc[the fees section]
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ The `&lowbar;&lowbar;validate&lowbar;&lowbar;` function ensures that any transac
Without this mechanism, a forged transaction can result in the sequencer stealing the user's funds.
In short, `&lowbar;&lowbar;validate&lowbar;&lowbar;` ensures that the sequencer may only include transactions that were approved by the account owner.

The arbitrary logic allowed in the `&lowbar;&lowbar;validate&lowbar;&lowbar;` function gives the account's designer the ability to determine what it means for a transaction to be valid. This gives rise to the usage of different signature schemes and other xref:architecture_and_concepts:Account_Abstraction/introduction.adoc#examples[exotic accounts].
The arbitrary logic allowed in the `&lowbar;&lowbar;validate&lowbar;&lowbar;` function gives the account's designer the ability to determine what it means for a transaction to be valid. This gives rise to the usage of different signature schemes
and other xref:architecture_and_concepts:Accounts/introduction.adoc#examples[exotic accounts].

[id="invalid_transactions"]
== Invalid transactions
Expand Down

This file was deleted.

Loading

0 comments on commit ffdcfe6

Please sign in to comment.