Skip to content

Commit d61cd91

Browse files
eric-stackslabsgitbook-bot
authored andcommitted
GITBOOK-13: added What's New? section
1 parent 6ed59d9 commit d61cd91

29 files changed

+84
-93
lines changed

docs/build/SUMMARY.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
## What's New?
1818

19-
* [✅ Clarity 4 is now LIVE! ](whats-new/clarity-4-is-now-live.md)
19+
* [✅ Clarity 4 is now LIVE!](whats-new/clarity-4-is-now-live.md)
2020

2121
## Learn Clarinet
2222

@@ -79,20 +79,17 @@
7979
* [Pyth Oracle Integration](stacks.js-integrations/pyth-oracle-integration.md)
8080
* [React Native Integration](stacks.js-integrations/react-native-integration.md)
8181

82-
***
83-
84-
* [Bitcoin Integration](bitcoin-integration/README.md)
85-
* [Sending Bitcoin with Leather](bitcoin-integration/sending-bitcoin-with-leather.md)
86-
* [Verifying a Bitcoin Transaction](bitcoin-integration/verifying-a-bitcoin-transaction.md)
87-
* [Parsing a Bitcoin Transaction](bitcoin-integration/parsing-a-bitcoin-transaction.md)
88-
* [sBTC](sbtc/README.md)
89-
* [sBTC Builder Quickstart](sbtc/sbtc-builder-quickstart.md)
90-
* [How to Use the sBTC JS Library for Bridging](sbtc/how-to-use-the-sbtc-js-library-for-bridging/README.md)
91-
* [Depositing: Pegging BTC into sBTC](sbtc/how-to-use-the-sbtc-js-library-for-bridging/btc-to-sbtc.md)
92-
* [Withdrawing: Pegging sBTC into BTC](sbtc/how-to-use-the-sbtc-js-library-for-bridging/sbtc-to-btc.md)
93-
* [Price Oracles](price-oracles.md)
94-
9582
## Misc. Guides
9683

84+
* [sBTC](misc.-guides/sbtc/README.md)
85+
* [sBTC Builder Quickstart](misc.-guides/sbtc/sbtc-builder-quickstart.md)
86+
* [How to Use the sBTC JS Library for Bridging](misc.-guides/sbtc/how-to-use-the-sbtc-js-library-for-bridging/README.md)
87+
* [Depositing: Pegging BTC into sBTC](misc.-guides/sbtc/how-to-use-the-sbtc-js-library-for-bridging/btc-to-sbtc.md)
88+
* [Withdrawing: Pegging sBTC into BTC](misc.-guides/sbtc/how-to-use-the-sbtc-js-library-for-bridging/sbtc-to-btc.md)
89+
* [Price Oracles](misc.-guides/price-oracles.md)
9790
* [Build a Borrowing & Lending Protocol](misc.-guides/build-a-borrowing-and-lending-protocol.md)
91+
* [Bitcoin Integration](misc.-guides/bitcoin-integration/README.md)
92+
* [Sending Bitcoin with Leather](misc.-guides/bitcoin-integration/sending-bitcoin-with-leather.md)
93+
* [Verifying a Bitcoin Transaction](misc.-guides/bitcoin-integration/verifying-a-bitcoin-transaction.md)
94+
* [Parsing a Bitcoin Transaction](misc.-guides/bitcoin-integration/parsing-a-bitcoin-transaction.md)
9895
* [Community Tutorials](misc.-guides/community-tutorials.md)

docs/build/clarinet-integrations/chainhook-integration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Prerequisites
2020

2121
{% stepper %}
2222
{% step %}
23-
### Create your Chainhook predicates
23+
#### Create your Chainhook predicates
2424

2525
Create predicate files in a `chainhooks/` directory alongside your contracts:
2626

@@ -63,7 +63,7 @@ Example predicate for monitoring increment events:
6363
{% endstep %}
6464

6565
{% step %}
66-
### Start devnet with Chainhooks
66+
#### Start devnet with Chainhooks
6767

6868
From your project root, start devnet. Clarinet registers every predicate automatically:
6969

@@ -83,7 +83,7 @@ INFO Feb 5 15:20:07.233382 2 chainhooks registered
8383
{% endstep %}
8484

8585
{% step %}
86-
### Monitor Chainhook activity
86+
#### Monitor Chainhook activity
8787

8888
Trigger contract actions and watch for Chainhook alerts:
8989

docs/build/clarinet-integrations/sbtc-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Clarinet can automatically wire up the official sBTC contracts so you can build
1717

1818
{% stepper %}
1919
{% step %}
20-
### Add sBTC to your project
20+
#### Add sBTC to your project
2121

2222
Add the sBTC contracts to your project requirements:
2323

@@ -35,7 +35,7 @@ Clarinet auto-funds devnet wallets with sBTC when these are present.
3535
{% endstep %}
3636

3737
{% step %}
38-
### Create an sBTC-enabled contract
38+
#### Create an sBTC-enabled contract
3939

4040
Example NFT marketplace that accepts sBTC payments:
4141

@@ -63,7 +63,7 @@ Example NFT marketplace that accepts sBTC payments:
6363
{% endstep %}
6464

6565
{% step %}
66-
### Test in the Clarinet console
66+
#### Test in the Clarinet console
6767

6868
Launch the console and try the contract using auto-funded wallets:
6969

@@ -79,7 +79,7 @@ clarinet console
7979
{% endstep %}
8080

8181
{% step %}
82-
### Write unit tests
82+
#### Write unit tests
8383

8484
Sample Vitest test for sBTC payments:
8585

@@ -124,7 +124,7 @@ describe('NFT Marketplace', () => {
124124
{% endstep %}
125125

126126
{% step %}
127-
### Deploy to testnet
127+
#### Deploy to testnet
128128

129129
Generate a plan to confirm remapped addresses for official sBTC contracts:
130130

docs/build/clarinet-integrations/stacks.js-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Use Stacks.js to interact with your Clarinet devnet from JavaScript applications
1313

1414
{% stepper %}
1515
{% step %}
16-
### Install Stacks.js packages
16+
#### Install Stacks.js packages
1717

1818
Add the required libraries to your frontend project:
1919

@@ -23,7 +23,7 @@ npm install @stacks/transactions @stacks/network
2323
{% endstep %}
2424

2525
{% step %}
26-
### Configure for devnet
26+
#### Configure for devnet
2727

2828
Create a network helper:
2929

@@ -48,7 +48,7 @@ export const accounts = {
4848
{% endstep %}
4949

5050
{% step %}
51-
### Test STX transfers
51+
#### Test STX transfers
5252

5353
Send a transfer between devnet accounts:
5454

@@ -76,7 +76,7 @@ Run the transfer with `ts-node stx-transfer.ts`.
7676
{% endstep %}
7777

7878
{% step %}
79-
### Call smart contracts
79+
#### Call smart contracts
8080

8181
Interact with contracts deployed on devnet:
8282

@@ -120,7 +120,7 @@ readCount().catch(console.error);
120120
{% endstep %}
121121

122122
{% step %}
123-
### Deploy contracts programmatically
123+
#### Deploy contracts programmatically
124124

125125
Deploy a contract from your application code:
126126

docs/build/clarinet-integrations/vscode-extension.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,25 +76,25 @@ When implementing traits (like SIP-009 NFTs or SIP-010 tokens), the extension ve
7676

7777
{% stepper %}
7878
{% step %}
79-
### Set breakpoints
79+
#### Set breakpoints
8080

8181
Set breakpoints by clicking line numbers in the editor.
8282
{% endstep %}
8383

8484
{% step %}
85-
### Start debugging
85+
#### Start debugging
8686

8787
Press `F5` or use Run → Start Debugging to begin a debugging session.
8888
{% endstep %}
8989

9090
{% step %}
91-
### Step through code
91+
#### Step through code
9292

9393
Step through code line-by-line to follow execution.
9494
{% endstep %}
9595

9696
{% step %}
97-
### Inspect state
97+
#### Inspect state
9898

9999
Inspect variables and stack state while paused at breakpoints.
100100
{% endstep %}

docs/build/clarinet-js-sdk/mainnet-execution-simulation.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ use_mainnet_wallets = true # !mark
5555
This is particularly useful when:
5656

5757
* Testing against mainnet-only contracts like DEX protocols
58-
* Your contract includes [`(is-standard standard-or-contract-principal)`](mainnet-execution-simulation.md#) validation
58+
* Your contract includes [`(is-standard standard-or-contract-principal)`](mainnet-execution-simulation.md) validation
5959
* Simulating transactions that require mainnet address formats
6060

6161
## Configure API access
@@ -139,13 +139,13 @@ Solution: Check the contract exists at your block height.
139139

140140
{% stepper %}
141141
{% step %}
142-
### Visit the playground
142+
#### Visit the playground
143143

144144
Go to: https://play.hiro.so/?remote\_data=true
145145
{% endstep %}
146146

147147
{% step %}
148-
### Run a mainnet contract call
148+
#### Run a mainnet contract call
149149

150150
Example Clarity call:
151151

@@ -154,4 +154,3 @@ Example Clarity call:
154154
```
155155
{% endstep %}
156156
{% endstepper %}
157-

docs/build/clarinet-js-sdk/unit-testing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Unit testing verifies that individual contract functions behave as expected. The
1111

1212
{% stepper %}
1313
{% step %}
14-
### Set up your project
14+
#### Set up your project
1515

1616
Create a new Clarinet project and install dependencies:
1717

@@ -23,7 +23,7 @@ npm install
2323
{% endstep %}
2424

2525
{% step %}
26-
### Create the contract
26+
#### Create the contract
2727

2828
Generate a contract stub:
2929

@@ -72,7 +72,7 @@ clarinet check
7272
{% endstep %}
7373

7474
{% step %}
75-
### Write your unit test
75+
#### Write your unit test
7676

7777
Create `tests/defi.test.ts` with a basic happy-path test:
7878

@@ -122,7 +122,7 @@ Key calls:
122122
{% endstep %}
123123

124124
{% step %}
125-
### Try it out
125+
#### Try it out
126126

127127
Run the tests:
128128

@@ -138,7 +138,7 @@ Test Files 1 passed (1)
138138
{% endstep %}
139139

140140
{% step %}
141-
### Generate coverage reports
141+
#### Generate coverage reports
142142

143143
```bash
144144
npm run test:report

docs/build/clarinet/clarity-formatter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ You can customize these defaults to match your preferences.
1616

1717
{% stepper %}
1818
{% step %}
19-
### Clarity VS Code Extension
19+
#### Clarity VS Code Extension
2020

2121
Format directly in the editor.
2222
{% endstep %}
2323

2424
{% step %}
25-
### Clarinet CLI
25+
#### Clarinet CLI
2626

2727
Format via command line, including entire projects.
2828
{% endstep %}

docs/build/clarinet/quickstart.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ description: >-
1919

2020
{% stepper %}
2121
{% step %}
22-
### Create your project
22+
#### Create your project
2323

2424
Let's start by creating a new Clarinet project. The `clarinet new` command sets up everything you need for smart contract development, including a testing framework, deployment configurations, and a local development environment:
2525

@@ -44,7 +44,7 @@ Clarinet creates a complete project structure for you. Each folder serves a spec
4444
{% endstep %}
4545

4646
{% step %}
47-
### Generate your contract
47+
#### Generate your contract
4848

4949
Now that we have our project structure, let's create a smart contract. Navigate into your project directory and use Clarinet's contract generator:
5050

@@ -69,7 +69,7 @@ Notice that Clarinet also updated your `Clarinet.toml` file. This configuration
6969
{% endstep %}
7070

7171
{% step %}
72-
### Write your contract code
72+
#### Write your contract code
7373

7474
Open `contracts/counter.clar` and replace its contents with our counter implementation. This contract will maintain a separate count for each user who interacts with it:
7575

@@ -99,7 +99,7 @@ Let's understand what each part does:
9999
{% endstep %}
100100

101101
{% step %}
102-
### Validate your contract
102+
#### Validate your contract
103103

104104
Before we can test our contract, let's make sure it's syntactically correct and type-safe. Clarinet's check command analyzes your contract without deploying it:
105105

@@ -117,7 +117,7 @@ If you see errors instead, here are the most common issues and how to fix them:
117117
{% endstep %}
118118

119119
{% step %}
120-
### Test in the console
120+
#### Test in the console
121121

122122
Now for the exciting part—let's interact with our contract! Clarinet provides an interactive console where you can call functions and see results immediately. Start the console with:
123123

@@ -139,4 +139,3 @@ u2
139139
```
140140
{% endstep %}
141141
{% endstepper %}
142-

docs/build/clarinet/validation-and-analysis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Error in contracts/token.clar:15:10
4545

4646
{% stepper %}
4747
{% step %}
48-
### Run basic checks
48+
#### Run basic checks
4949

5050
Use `clarinet check` to validate your contracts and catch type/syntax errors before deployment.
5151

@@ -55,7 +55,7 @@ clarinet check
5555
{% endstep %}
5656

5757
{% step %}
58-
### Check a specific contract
58+
#### Check a specific contract
5959

6060
Focus validation during development on a single contract file:
6161

@@ -65,7 +65,7 @@ clarinet check contracts/nft.clar
6565
{% endstep %}
6666

6767
{% step %}
68-
### Integrate into CI
68+
#### Integrate into CI
6969

7070
Automate validation in continuous integration pipelines. Example GitHub Actions workflow:
7171

0 commit comments

Comments
 (0)