Skip to content

Commit 65f489e

Browse files
authored
Summary of my three attempts to rewrite documentation (#1)
1 parent 88b2ad6 commit 65f489e

70 files changed

Lines changed: 938 additions & 2175 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Use the table of contents icon on the top left corner of this document to get to
1010

1111
## New contributor guide
1212

13-
To get an overview of the project, read the [README](https://github.com/anthias-labs/arbiter/blob/main/README.md). Here are some resources to help you get started with open source contributions:
13+
To get an overview of the project, read the [README](https://github.com/astraly-labs/starkbiter/blob/main/README.md). Here are some resources to help you get started with open source contributions:
1414

1515
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
1616
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
@@ -28,7 +28,7 @@ If you spot a problem with the docs, [search if an issue already exists](https:/
2828

2929
#### Solve an issue
3030

31-
Scan through our [existing issues](https://github.com/anthias-labs/arbiter/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix.
31+
Scan through our [existing issues](https://github.com/astraly-labs/starkbiter/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix.
3232

3333
### Make Changes
3434

@@ -64,4 +64,4 @@ Once you submit your PR, a Arbiter team member will review your proposal. We may
6464

6565
Congratulations :tada::tada: The Anthias Labs team thanks you :sparkles:.
6666

67-
Once your PR is merged, your contributions will be publicly visible on the [Arbiter Repository](https://github.com/anthias-labs/arbiter).
67+
Once your PR is merged, your contributions will be publicly visible on the [Arbiter Repository](https://github.com/astraly-labs/starkbiter).

.github/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ updates:
1111
interval: "daily"
1212

1313
- package-ecosystem: "cargo"
14-
directory: "arbiter-core"
14+
directory: "starkbiter-core"
1515
schedule:
1616
interval: "daily"

.github/workflows/lint.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ jobs:
3636
with:
3737
toolchain: stable
3838
components: clippy
39-
- name: git submodule update
40-
run: git submodule update --init --recursive
4139
- name: cargo clippy
4240
run: cargo clippy --workspace --all-features -- -D warnings
4341

@@ -68,4 +66,4 @@ jobs:
6866
check_hidden: true
6967
check_filenames: true
7068
skip: .git,Cargo.lock,target,CHANGELOG.md,engine,core,macros,examples,bindings,bin
71-
ignore_words_list: crate,Crate,functio
69+
ignore_words_list: crate,Crate,functio

.github/workflows/test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
pull_request:
55
types: [opened, synchronize, reopened]
66
paths-ignore:
7-
- "arbiter-bindings/*"
7+
- "starkbiter-bindings/*"
88

99
jobs:
1010
test:

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ arbiter/
1919
# mdbook
2020
book
2121

22-
arbiter-core/data
22+
starkbiter-core/data
2323
example_fork/test.json
2424

2525
doctest_cache/

CHANGELOG.md

Lines changed: 96 additions & 96 deletions
Large diffs are not rendered by default.

Cargo.lock

Lines changed: 115 additions & 115 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,27 @@ exclude = ["benches", "docs"]
77

88
# Package configuration
99
[package]
10-
name = "arbiter"
11-
version = "0.4.20"
10+
name = "starkbiter"
11+
version = "0.1.0"
1212
edition = "2021"
13-
authors = [
14-
"Waylon Jepsen <waylonjepsen1@gmail.com>",
15-
"Colin Roberts <colin@autoparallel.xyz>",
16-
]
17-
description = "Allowing smart contract developers to do simulation driven development via an EVM emulator"
13+
authors = ["Baitcode <batiyiv@gmail.com>", "Matthias <matthias@pragma.build>"]
14+
description = "Allowing smart contract developers to do simulation driven development via an Starknet Devnet emulator"
1815
license = "Apache-2.0"
19-
keywords = ["ethereum", "evm", "emulator", "testing", "smart-contracts"]
16+
keywords = [
17+
"starknet",
18+
"cairo",
19+
"emulator",
20+
"simulator",
21+
"simulation",
22+
"agents",
23+
"bindings",
24+
"testing",
25+
"smart-contracts",
26+
]
2027

2128
# Binary configuration
2229
[[bin]]
23-
name = "arbiter"
30+
name = "starkbiter"
2431
path = "bin/main.rs"
2532

2633
[[example]]
@@ -29,10 +36,10 @@ path = "examples/minter/main.rs"
2936

3037
[workspace.dependencies]
3138
# Arbiter local for development
32-
arbiter-bindings = { path = "bindings" }
33-
arbiter-core = { path = "core" }
34-
arbiter-engine = { path = "engine" }
35-
arbiter-macros = { path = "macros" }
39+
starkbiter-bindings = { path = "bindings" }
40+
starkbiter-core = { path = "core" }
41+
starkbiter-engine = { path = "engine" }
42+
starkbiter-macros = { path = "macros" }
3643

3744
# starknet-devnet-core = { path = "/Users/baitcode/work/starknet/starknet-devnet/crates/starknet-devnet-core" }
3845
starknet-devnet-core = { git = "https://github.com/baitcode/starknet-devnet.git", branch = "experiment" }
@@ -78,7 +85,7 @@ anyhow = "1.0.83"
7885
# Dependencies for the release build of Arbiter bin
7986
[dependencies]
8087

81-
arbiter-core.workspace = true
88+
starkbiter-core.workspace = true
8289

8390
starknet-accounts.workspace = true
8491
starknet-signers.workspace = true
@@ -107,9 +114,9 @@ tempfile = { version = "3.10.1" }
107114
thiserror.workspace = true
108115
# Dependencies for the test build and development
109116
[dev-dependencies]
110-
arbiter-bindings.workspace = true
111-
arbiter-engine.workspace = true
112-
arbiter-macros.workspace = true
117+
starkbiter-bindings.workspace = true
118+
starkbiter-engine.workspace = true
119+
starkbiter-macros.workspace = true
113120
starknet-core.workspace = true
114121
serde.workspace = true
115122
async-trait.workspace = true

0 commit comments

Comments
 (0)