Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add limitations to __validate__ function and other improvements to Accounts section #945

Closed
wants to merge 43 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
2c35cd8
Add limitations to __validate__ function
stoobie Nov 20, 2023
c4ec7f0
Merge branch 'dev' into steve/add_limitations_to_validate_fn
stoobie Nov 20, 2023
ed3ae9e
Removed HTML entities for underscore and replaced with actual undersc…
stoobie Nov 20, 2023
de8b949
Removed HTML entities for underscore and replaced with actual undersc…
stoobie Nov 20, 2023
51cce88
Added info on what the validate and execute functions do. Other minor…
stoobie Nov 20, 2023
1c8ed2c
Merge branch 'master' into steve/add_limitations_to_validate_fn
stoobie Nov 28, 2023
07634a1
Apply suggestions from code review
stoobie Dec 4, 2023
9463082
Restructured the topic Deploying a new account
stoobie Dec 5, 2023
76be2e9
Changed DOS to DoS.
stoobie Dec 5, 2023
1d8d93d
Changes and restructuring approach.adoc.
stoobie Dec 5, 2023
06fa0b3
Changes and restructuring deploying_new_accounts.adoc.
stoobie Dec 5, 2023
b2aaab2
More edits
stoobie Dec 5, 2023
742bdf9
More edits
stoobie Dec 5, 2023
a117450
More edits
stoobie Dec 5, 2023
113cf73
Apply suggestions from code review
stoobie Jan 7, 2024
1314a6d
Apply suggestions from code review
stoobie Jan 8, 2024
190a4df
Update components/Starknet/modules/architecture_and_concepts/pages/Ac…
stoobie Jan 8, 2024
b2799db
Merge branch 'main' into steve/add_limitations_to_validate_fn
stoobie Feb 25, 2024
d2b5187
Some SME comments
stoobie Feb 25, 2024
47defd7
SME comments
stoobie Feb 25, 2024
0706d14
SME comments
stoobie Feb 25, 2024
58ab334
SME comments
stoobie Feb 25, 2024
de0ef79
Cleaning up, clarifications
stoobie Feb 26, 2024
b8dfbc8
Cleaning up, clarifications
stoobie Feb 26, 2024
8dd2be0
Merge branch 'steve/add_limitations_to_validate_fn' of github.com:sta…
stoobie Feb 29, 2024
6c6c0f3
Testing Solidity formatting.
stoobie Feb 29, 2024
cc82904
Testing Solidity formatting.
stoobie Feb 29, 2024
4fe0968
Reverting Solidity example that was added for testing formatting.
stoobie Feb 29, 2024
8b7dbbb
Clarified _Deploying a new account_
stoobie Mar 3, 2024
c7c492c
Removed details about functions from approach.adoc. These details app…
stoobie Mar 3, 2024
4ab6249
Cleaning up.
stoobie Mar 4, 2024
8cd664b
Reverting deploying_new_accounts.adoc to version on main. I moved the…
stoobie Mar 6, 2024
9178ad6
Delineating functions in one H2 section.
stoobie Mar 6, 2024
07f71df
Deleted table with details of functions.
stoobie Mar 6, 2024
6c436ef
Tightening up text
stoobie Mar 19, 2024
db71a86
Mention the constructor function.
stoobie Mar 20, 2024
474400a
Mention the constructor function. Minor edits.
stoobie Mar 20, 2024
14a0a2e
Remove mini-toc
stoobie Mar 20, 2024
f9c46d8
Changed title in nav.adoc to `Account interface function reference`
stoobie Mar 20, 2024
af1611a
SME comments
stoobie Mar 25, 2024
0e3b14e
SME comments
stoobie Mar 25, 2024
cf70714
Syncing fee-mechanism.adoc and limits_and_triggers.adoc with main.
stoobie Mar 25, 2024
0db47fa
Merge branch 'main' into steve/add_limitations_to_validate_fn
stoobie Mar 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ on:
branches:
- '*'

# push:
# branches:
# - main

jobs:

typos:
Expand Down Expand Up @@ -84,6 +88,7 @@ jobs:
ls -al
echo "Git status:"
git status

git config user.name "GitHub Actions"
git config user.email [email protected]
git add .
Expand All @@ -100,7 +105,7 @@ jobs:

# Commit changes
git commit -m "$commit_message"

# Check if commit was successful
if [ $? -eq 0 ]; then
# Debug information
Expand Down Expand Up @@ -135,4 +140,5 @@ 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: 11 additions & 7 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Push workflow
on:
push:
branches:
# - dev
- main

jobs:
Expand All @@ -28,11 +29,14 @@ jobs:
git config --global user.name "${{ secrets.USER_NAME }}"
git config --global user.email "${{ secrets.USER_EMAIL }}"

- name: Generate Site
run: yarn generate
- name: Run release script
if: ${{ github.ref_name == 'main' }}
run: yarn run release

- 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 }}:~/
- 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
8 changes: 7 additions & 1 deletion .htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ RewriteRule ^docs/Blocks/transaction\-life\-cycle/$ /documentation/architecture_

RewriteCond %{QUERY_STRING} ^$
RewriteRule ^/develop/Blocks/transaction\-life\-cycle/$ /documentation/architecture_and_concepts/Network_Architecture/transaction-life-cycle? [R=301,L]

architecture_and_concepts
RewriteCond %{QUERY_STRING} ^$
RewriteRule ^docs/Blocks/transaction\-life\-cycle/index\.html$ /documentation/architecture_and_concepts/Network_Architecture/transaction-life-cycle? [R=301,L]

Expand Down 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
78 changes: 0 additions & 78 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,84 +2,6 @@

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)
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
[IMPORTANT]
====
Goerli testnet 2 is removed. Goerli testnet support will be removed April 11, 2024. 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.
====
Goerli testnet 2 is removed. Use Goerli testnet.
====
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 4 additions & 7 deletions components/Starknet/modules/architecture_and_concepts/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@

** 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
Expand All @@ -31,15 +30,13 @@
*** 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/system-calls-cairo1.adoc[System calls]

*** 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]
* xref:Economics-of-Starknet.adoc[The Economics of Starknet]
Loading
Loading