Skip to content

Commit

Permalink
Merge branch 'main' into starknet_message
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaolou86 authored Apr 8, 2024
2 parents 268b837 + 0f1d847 commit 8a1a9fb
Show file tree
Hide file tree
Showing 66 changed files with 4,722 additions and 3,355 deletions.
8 changes: 1 addition & 7 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ on:
branches:
- '*'

# push:
# branches:
# - main

jobs:

typos:
Expand Down Expand Up @@ -88,7 +84,6 @@ jobs:
ls -al
echo "Git status:"
git status
git config user.name "GitHub Actions"
git config user.email noreply@github.com
git add .
Expand All @@ -105,7 +100,7 @@ jobs:
# Commit changes
git commit -m "$commit_message"
# Check if commit was successful
if [ $? -eq 0 ]; then
# Debug information
Expand Down Expand Up @@ -140,5 +135,4 @@ jobs:
echo "Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/${{ steps.pr.outputs.PR_ID }}/documentation/ ." >/tmp/comment
gh pr comment ${{ github.event.pull_request.number }} -F /tmp/comment
env:
# USER_TOKEN: "${{ secrets.USER_TOKEN }}"
GH_TOKEN: "${{ github.token }}"
18 changes: 7 additions & 11 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ name: Push workflow
on:
push:
branches:
# - dev
- main

jobs:
Expand All @@ -29,14 +28,11 @@ jobs:
git config --global user.name "${{ secrets.USER_NAME }}"
git config --global user.email "${{ secrets.USER_EMAIL }}"
- name: Run release script
if: ${{ github.ref_name == 'main' }}
run: yarn run release
- name: Generate Site
run: yarn generate

- name: Push to remote branch
uses: ad-m/github-push-action@master
with:
USER_TOKEN: ${{ secrets.USER_TOKEN }}
branch: ${{ github.ref }}
tags: true
force: true
- name: Zip artifacts
run: zip -r ${{ steps.get-release-data.outputs.file }}.zip package.json CHANGELOG.md

- name: scp upload to production site
run: sshpass -p ${{ secrets.PROD_PASS }} scp -o 'StrictHostKeyChecking no' -r public_html/ ${{ secrets.PROD_USER }}@${{ secrets.PROD_IP }}:~/
6 changes: 6 additions & 0 deletions .htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,12 @@ RewriteRule ^documentation/architecture_and_concepts/Cairo_on_Starknet/contract\
RewriteCond %{QUERY_STRING} ^$
RewriteRule ^documentation/architecture_and_concepts/Cairo_on_Starknet/contract\-syntax/index\.html$ /documentation/architecture_and_concepts/Smart_Contracts/contract-syntax? [R=301,L]

RewriteCond %{QUERY_STRING} ^$
RewriteRule ^documentation/architecture_and_concepts/Accounts/validate_and_execute/index\.html$ /documentation/architecture_and_concepts/Accounts/account_functions? [R=301,L]

RewriteCond %{QUERY_STRING} ^$
RewriteRule ^documentation/architecture_and_concepts/Accounts/validate_and_execute/$ /documentation/architecture_and_concepts/Accounts/account_functions? [R=301,L]

RewriteCond %{QUERY_STRING} ^$
RewriteRule ^documentation/getting_started/environment_setup/$ /documentation/quick_start/environment_setup? [R=301,L]

Expand Down
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{}

145 changes: 145 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,151 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [0.1.514](https://github.com/starknet-io/starknet-docs/compare/v0.1.513...v0.1.514) (2024-03-14)

### [0.1.513](https://github.com/starknet-io/starknet-docs/compare/v0.1.512...v0.1.513) (2024-03-14)

### [0.1.512](https://github.com/starknet-io/starknet-docs/compare/v0.1.511...v0.1.512) (2024-03-14)

### [0.1.511](https://github.com/starknet-io/starknet-docs/compare/v0.1.510...v0.1.511) (2024-03-13)

### [0.1.510](https://github.com/starknet-io/starknet-docs/compare/v0.1.509...v0.1.510) (2024-03-13)

### [0.1.509](https://github.com/starknet-io/starknet-docs/compare/v0.1.508...v0.1.509) (2024-03-13)

### [0.1.508](https://github.com/starknet-io/starknet-docs/compare/v0.1.507...v0.1.508) (2024-03-12)

### [0.1.507](https://github.com/starknet-io/starknet-docs/compare/v0.1.506...v0.1.507) (2024-03-12)


### Bug Fixes

* add felt size multiplier to data gas usage ([#1174](https://github.com/starknet-io/starknet-docs/issues/1174)) ([6e2a41e](https://github.com/starknet-io/starknet-docs/commit/6e2a41e60625c9d2f96e5b5b7ad739698294a18d))

### [0.1.506](https://github.com/starknet-io/starknet-docs/compare/v0.1.505...v0.1.506) (2024-03-11)

### [0.1.505](https://github.com/starknet-io/starknet-docs/compare/v0.1.504...v0.1.505) (2024-03-10)


### Bug Fixes

* Fix example in emit_events ([#1169](https://github.com/starknet-io/starknet-docs/issues/1169)) ([75b08a1](https://github.com/starknet-io/starknet-docs/commit/75b08a17fff8e8b0ca07d303b8d29b55390d6588))

### [0.1.504](https://github.com/starknet-io/starknet-docs/compare/v0.1.503...v0.1.504) (2024-03-10)

### [0.1.503](https://github.com/starknet-io/starknet-docs/compare/v0.1.502...v0.1.503) (2024-03-07)

### [0.1.502](https://github.com/starknet-io/starknet-docs/compare/v0.1.501...v0.1.502) (2024-03-07)

### [0.1.501](https://github.com/starknet-io/starknet-docs/compare/v0.1.500...v0.1.501) (2024-03-06)

### [0.1.500](https://github.com/starknet-io/starknet-docs/compare/v0.1.499...v0.1.500) (2024-03-06)

### [0.1.499](https://github.com/starknet-io/starknet-docs/compare/v0.1.498...v0.1.499) (2024-03-05)

### [0.1.498](https://github.com/starknet-io/starknet-docs/compare/v0.1.497...v0.1.498) (2024-03-05)

### [0.1.497](https://github.com/starknet-io/starknet-docs/compare/v0.1.496...v0.1.497) (2024-02-29)

### [0.1.496](https://github.com/starknet-io/starknet-docs/compare/v0.1.495...v0.1.496) (2024-02-29)


### Features

* Added callouts to example in Data availability topic. ([#1006](https://github.com/starknet-io/starknet-docs/issues/1006)) ([e1b8500](https://github.com/starknet-io/starknet-docs/commit/e1b850074a9d2fdfa8113bef7de48b0fa1cca8ac))

### [0.1.495](https://github.com/starknet-io/starknet-docs/compare/v0.1.494...v0.1.495) (2024-02-29)


### Bug Fixes

* Testing highlightjs-cairo v4.0 in starknet-docs-antora-ui ([#1153](https://github.com/starknet-io/starknet-docs/issues/1153)) ([1668841](https://github.com/starknet-io/starknet-docs/commit/1668841717103e1b49d6221024c8f736419f6034))

### [0.1.494](https://github.com/starknet-io/starknet-docs/compare/v0.1.493...v0.1.494) (2024-02-28)

### [0.1.493](https://github.com/starknet-io/starknet-docs/compare/v0.1.492...v0.1.493) (2024-02-26)


### Bug Fixes

* Update validation info in transaction_lifecycle.adoc ([#1151](https://github.com/starknet-io/starknet-docs/issues/1151)) ([2fc6bbf](https://github.com/starknet-io/starknet-docs/commit/2fc6bbfc6b8f90a059657aa3aa63c9067ec958c7))

### [0.1.492](https://github.com/starknet-io/starknet-docs/compare/v0.1.491...v0.1.492) (2024-02-26)

### [0.1.491](https://github.com/starknet-io/starknet-docs/compare/v0.1.490...v0.1.491) (2024-02-26)


### Bug Fixes

* generate previews from forked repos ([#1097](https://github.com/starknet-io/starknet-docs/issues/1097)) ([f37a901](https://github.com/starknet-io/starknet-docs/commit/f37a9016c571c038740b50b8f2b5b27511450b62))

### [0.1.490](https://github.com/starknet-io/starknet-docs/compare/v0.1.489...v0.1.490) (2024-02-25)

### [0.1.489](https://github.com/starknet-io/starknet-docs/compare/v0.1.488...v0.1.489) (2024-02-25)

### [0.1.488](https://github.com/starknet-io/starknet-docs/compare/v0.1.487...v0.1.488) (2024-02-25)

### [0.1.487](https://github.com/starknet-io/starknet-docs/compare/v0.1.486...v0.1.487) (2024-02-25)

### [0.1.486](https://github.com/starknet-io/starknet-docs/compare/v0.1.485...v0.1.486) (2024-02-22)

### [0.1.485](https://github.com/starknet-io/starknet-docs/compare/v0.1.484...v0.1.485) (2024-02-22)

### [0.1.484](https://github.com/starknet-io/starknet-docs/compare/v0.1.483...v0.1.484) (2024-02-21)

### [0.1.483](https://github.com/starknet-io/starknet-docs/compare/v0.1.482...v0.1.483) (2024-02-21)

### [0.1.482](https://github.com/starknet-io/starknet-docs/compare/v0.1.481...v0.1.482) (2024-02-21)

### [0.1.481](https://github.com/starknet-io/starknet-docs/compare/v0.1.480...v0.1.481) (2024-02-21)

### [0.1.480](https://github.com/starknet-io/starknet-docs/compare/v0.1.479...v0.1.480) (2024-02-19)

### [0.1.479](https://github.com/starknet-io/starknet-docs/compare/v0.1.478...v0.1.479) (2024-02-15)

### [0.1.478](https://github.com/starknet-io/starknet-docs/compare/v0.1.477...v0.1.478) (2024-02-15)

### [0.1.477](https://github.com/starknet-io/starknet-docs/compare/v0.1.476...v0.1.477) (2024-02-14)

### [0.1.476](https://github.com/starknet-io/starknet-docs/compare/v0.1.475...v0.1.476) (2024-02-14)


### Bug Fixes

* Minor edits to Economics-of-Starknet.adoc ([#1130](https://github.com/starknet-io/starknet-docs/issues/1130)) ([d00cfa6](https://github.com/starknet-io/starknet-docs/commit/d00cfa6f9aa3f9ebb42bd77e6c1bfc3c0fb830ae))

### [0.1.475](https://github.com/starknet-io/starknet-docs/compare/v0.1.474...v0.1.475) (2024-02-14)

### [0.1.474](https://github.com/starknet-io/starknet-docs/compare/v0.1.473...v0.1.474) (2024-02-13)

### [0.1.473](https://github.com/starknet-io/starknet-docs/compare/v0.1.472...v0.1.473) (2024-02-11)


### Bug Fixes

* ignore fee token contract is the fee formula ([#1123](https://github.com/starknet-io/starknet-docs/issues/1123)) ([3863f6f](https://github.com/starknet-io/starknet-docs/commit/3863f6f693e3f3d06ee53f67cff4e7afb4334e13))

### [0.1.472](https://github.com/starknet-io/starknet-docs/compare/v0.1.471...v0.1.472) (2024-02-11)

### [0.1.471](https://github.com/starknet-io/starknet-docs/compare/v0.1.470...v0.1.471) (2024-02-08)

### [0.1.470](https://github.com/starknet-io/starknet-docs/compare/v0.1.469...v0.1.470) (2024-02-08)

### [0.1.469](https://github.com/starknet-io/starknet-docs/compare/v0.1.468...v0.1.469) (2024-02-06)

### [0.1.468](https://github.com/starknet-io/starknet-docs/compare/v0.1.467...v0.1.468) (2024-02-05)

### [0.1.467](https://github.com/starknet-io/starknet-docs/compare/v0.1.466...v0.1.467) (2024-02-05)

### [0.1.466](https://github.com/starknet-io/starknet-docs/compare/v0.1.465...v0.1.466) (2024-02-04)

### [0.1.465](https://github.com/starknet-io/starknet-docs/compare/v0.1.464...v0.1.465) (2024-02-04)


### Bug Fixes

* fee calculation formula ([#1092](https://github.com/starknet-io/starknet-docs/issues/1092)) ([0c36768](https://github.com/starknet-io/starknet-docs/commit/0c367688427c9bff7c4e74e60b7b4da2bc8009da))

### [0.1.464](https://github.com/starknet-io/starknet-docs/compare/v0.1.463...v0.1.464) (2024-01-30)

### [0.1.463](https://github.com/starknet-io/starknet-docs/compare/v0.1.462...v0.1.463) (2024-01-28)
Expand Down
8 changes: 4 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,21 @@ Hit CTRL-C to stop the server
----

== Releasing Starknet docs on Github (for Admins only)
== Releasing Starknet docs on GitHub (for Admins only)

_The high-level process for releasing documentation changes in this repository._

During the course of content development, writers merge branches with changes either directly into `main`, into a secondary branch as needed, where these changes wait until we are ready to release them—that is, post them to link:https://docs.starknet.io[docs.starknet.io].

Github actions create Git tags and releases that appear at the repo’s link:https://github.com/starknet-community-libs/starknet-docs/releases[Releases] and link:https://github.com/starknet-community-libs/starknet-docs/tags[Tags] pages.
GitHub actions create Git tags and releases that appear at the repo’s link:https://github.com/starknet-community-libs/starknet-docs/releases[Releases] and link:https://github.com/starknet-community-libs/starknet-docs/tags[Tags] pages.

When a feature branch is merged into the `main` branch, a github action creates a release tag in the format `v<version>.<major_update>.<minor_update>` and updates `CHANGELOG.md`. It then publishes the new content to docs.starknet.io.
When a feature branch is merged into the `main` branch, a GitHub action creates a release tag in the format `v<version>.<major_update>.<minor_update>` and updates `CHANGELOG.md`. It then publishes the new content to docs.starknet.io.

=== Procedure

Merging a feature branch to `main` automatically publishes changes in the feature branch. No additional steps are required.

Github increments the version numbers in `package.json` and `package-lock.json`, and updates `CHANGELOG.md` with the descriptions of each PR that was just merged into `main`.
GitHub increments the version numbers in `package.json` and `package-lock.json`, and updates `CHANGELOG.md` with the descriptions of each PR that was just merged into `main`.
. Update your local `main` branch from the remote `main` branch using one of the following:

* Pull the changes:
Expand Down
3 changes: 3 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ check-file = false
extend-glob = ["*.adoc"]
check-file = true

[default.extend-words]
# Don't correct the word
afe = "afe"
1 change: 1 addition & 0 deletions components/Starknet/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ nav:
- 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
1 change: 1 addition & 0 deletions components/Starknet/modules/ROOT/nav_glossary.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* xref:glossary.adoc[]
7 changes: 7 additions & 0 deletions components/Starknet/modules/ROOT/pages/glossary.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
include::1.0.0@docs-common-content:ROOT:partial$partial_glossary.adoc[]

// The source for the included file is in a separate repository.
//
// To edit the source page directly, go to:
//
// `https://github.com/starknet-io/docs-common-content/edit/main/modules/ROOT/partials/partial_glossary.adoc`
4 changes: 2 additions & 2 deletions components/Starknet/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[id="overview"]
= Overview

Starknet is a permissionless, decentralized zero-knowledge rollup (ZK rollup) for Ethereum. It operates as a Layer 2 (L2) blockchain, enabling any dApp to achieve unlimited scale for its computation without compromising on Ethereum’s composability
Starknet is a permissionless, Validity-Rollup, also known as a zero-knowledge rollup (ZK rollup) for Ethereum. It operates as a Layer 2 (L2) blockchain, enabling any dApp to achieve massive scale for its computation without compromising on Ethereum’s composability
and security.

Starknet achieves secure low cost transactions and high performance by using the STARK cryptographic proof system. Starknet contracts and the Starknet OS are written in link:https://github.com/starkware-libs/cairo[Cairo], a custom-built and
Starknet aims to achieves secure low cost transactions and high performance by using the STARK cryptographic proof system. Starknet contracts and the Starknet OS are written in link:https://github.com/starkware-libs/cairo[Cairo], a custom-built and
specialized programming language.

== Explore Starknet
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[IMPORTANT]
====
.Goerli testnet support is now removed.
Originally, Goerli testnet was scheduled to be removed April 11, 2024, however, following the recent mass exit of Ethereum Goerli validators and the current inactivity of Starknet Goerli, Starknet Goerli testnet is now shut down, to avoid maintaining an inactive network.
Sepolia testnet replaces Goerli testnet.
For more information, including bridge support for Sepolia, see link:http://eepurl.com/iK0YTE[Starknet Goerli Deprecation] in the Starknet Dev News newsletter.
====
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 19 additions & 16 deletions components/Starknet/modules/architecture_and_concepts/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,41 +1,44 @@
* Architecture
** Blockchain architecture
** xref:Network_Architecture/starknet_architecture_overview.adoc[Overview]

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

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

*** L1-L2 messaging
**** xref:Network_Architecture/messaging-mechanism.adoc[Messaging mechanism]
**** xref:Network_Architecture/messaging_reference.adoc[Messaging reference]
** L1-L2 messaging
*** xref:Network_Architecture/messaging-mechanism.adoc[Messaging mechanism]
*** xref:Network_Architecture/messaging_reference.adoc[Messaging reference]

** Accounts
*** xref:Accounts/introduction.adoc[What is an account?]
*** xref:Accounts/approach.adoc[Starknet account interface]
*** xref:Accounts/validate_and_execute.adoc[Validate and execute]
*** xref:Accounts/approach.adoc[Starknet's account interface]
*** xref:Accounts/account_functions.adoc[Account interface function reference]
*** xref:Accounts/deploying_new_accounts.adoc[Deploying new accounts]
*** xref:Accounts/universal-deployer.adoc[Universal Deployer Contract]
*** xref:Accounts/simplified_transaction_flow.adoc[Simplified transaction flow]

** Contracts
*** xref:Smart_Contracts/contract-classes.adoc[Contract classes]
*** xref:Smart_Contracts/contract-classes.adoc[Contract classes and instances]
*** 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/starknet-events.adoc[Events]
*** xref:Smart_Contracts/contract-syntax.adoc[Migrating a contract from Cairo v1 to Cairo v2]
*** xref:Smart_Contracts/cairo-and-sierra.adoc[Cairo and Sierra]
*** xref:Smart_Contracts/universal-deployer.adoc[Universal Deployer Contract]
*** xref:Smart_Contracts/serialization_of_Cairo_types.adoc[Serialization of Cairo types]
*** xref:Smart_Contracts/system-calls-cairo1.adoc[System calls]
*** xref:Smart_Contracts/execution_info.adoc[Execution information for the current block]
** Cryptography
*** xref:Cryptography/p-value.adoc[The STARK field]
*** xref:Cryptography/stark-curve.adoc[The STARK curve]
*** xref:Cryptography/hash-functions.adoc[Hash functions]

* xref:Economics-of-Starknet.adoc[The Economics of Starknet]
Loading

0 comments on commit 8a1a9fb

Please sign in to comment.