diff --git a/docs/reference/.gitbook/assets/image (1).png b/docs/build/.gitbook/assets/clarinet-diagram.png similarity index 100% rename from docs/reference/.gitbook/assets/image (1).png rename to docs/build/.gitbook/assets/clarinet-diagram.png diff --git a/docs/reference/.gitbook/assets/image (1) (1).png b/docs/build/.gitbook/assets/clarinet-sdk.png similarity index 100% rename from docs/reference/.gitbook/assets/image (1) (1).png rename to docs/build/.gitbook/assets/clarinet-sdk.png diff --git a/docs/reference/.gitbook/assets/image (3).png b/docs/build/.gitbook/assets/stacksjs-learn.png similarity index 100% rename from docs/reference/.gitbook/assets/image (3).png rename to docs/build/.gitbook/assets/stacksjs-learn.png diff --git a/docs/build/SUMMARY.md b/docs/build/SUMMARY.md index 4664143daa..754e5dae9c 100644 --- a/docs/build/SUMMARY.md +++ b/docs/build/SUMMARY.md @@ -18,6 +18,67 @@ * [✅ Clarity 4 is now LIVE! ](whats-new/clarity-4-is-now-live.md) +## Learn Clarinet + +* [Overview](clarinet/overview.md) +* [Quickstart](clarinet/quickstart.md) +* [Project Structure](clarinet/project-structure.md) +* [Project Development](clarinet/project-development.md) +* [Contract Interaction](clarinet/contract-interaction.md) +* [Validation and Analysis](clarinet/validation-and-analysis.md) +* [Clarity Formatter](clarinet/clarity-formatter.md) +* [Local Blockchain Development](clarinet/local-blockchain-development.md) +* [Contract Deployment](clarinet/contract-deployment.md) +* [FAQ](clarinet/faq.md) + +## Clarinet JS SDK + +* [Overview](clarinet-js-sdk/overview.md) +* [Unit Testing](clarinet-js-sdk/unit-testing.md) +* [Integration Testing](clarinet-js-sdk/integration-testing.md) +* [Mainnet Execution Simulation](clarinet-js-sdk/mainnet-execution-simulation.md) + +## Clarinet Integrations + +* [Pyth Oracle Integration](clarinet-integrations/pyth-oracle-integration.md) +* [Chainhook Integration](clarinet-integrations/chainhook-integration.md) +* [Stacks.js Integration](clarinet-integrations/stacks.js-integration.md) +* [sBTC Integration](clarinet-integrations/sbtc-integration.md) +* [VSCode Extension](clarinet-integrations/vscode-extension.md) + +## Learn Stacks.js + +* [Overview](stacks.js/overview.md) +* [Accounts & Addresses](stacks.js/accounts-and-addresses.md) +* [Private Keys](stacks.js/private-keys.md) +* [Networks](stacks.js/networks.md) +* [Read Only Calls](stacks.js/read-only-calls.md) +* [Build Transactions](stacks.js/build-transactions.md) +* [Contract Calls](stacks.js/contract-calls.md) +* [Contract Deployment](stacks.js/contract-deployment.md) +* [Address Validation](stacks.js/address-validation.md) +* [Encoding & Decoding](stacks.js/encoding-and-decoding.md) +* [Network Configuration](stacks.js/network-configuration.md) +* [Unit Conversion](stacks.js/unit-conversion.md) + +## Stacks Connect + +* [Connect Wallet](stacks-connect/connect-wallet.md) +* [Broadcast Transactions](stacks-connect/broadcast-transactions.md) +* [Message Signing](stacks-connect/message-signing.md) +* [Migration Guide](stacks-connect/migration-guide.md) +* [Wallet Support](stacks-connect/wallet-support.md) + +## Post-Conditions + +* [Overview](post-conditions/overview.md) +* [Implementing Post Conditions](post-conditions/implementing-post-conditions.md) + +## Stacks.js Integrations + +* [Pyth Oracle Integration](stacks.js-integrations/pyth-oracle-integration.md) +* [React Native Integration](stacks.js-integrations/react-native-integration.md) + *** * [Bitcoin Integration](bitcoin-integration/README.md) diff --git a/docs/reference/clarinet-integrations/chainhook-integration.md b/docs/build/clarinet-integrations/chainhook-integration.md similarity index 100% rename from docs/reference/clarinet-integrations/chainhook-integration.md rename to docs/build/clarinet-integrations/chainhook-integration.md diff --git a/docs/reference/clarinet-integrations/pyth-oracle-integration.md b/docs/build/clarinet-integrations/pyth-oracle-integration.md similarity index 100% rename from docs/reference/clarinet-integrations/pyth-oracle-integration.md rename to docs/build/clarinet-integrations/pyth-oracle-integration.md diff --git a/docs/reference/clarinet-integrations/sbtc-integration.md b/docs/build/clarinet-integrations/sbtc-integration.md similarity index 100% rename from docs/reference/clarinet-integrations/sbtc-integration.md rename to docs/build/clarinet-integrations/sbtc-integration.md diff --git a/docs/reference/clarinet-integrations/stacks.js-integration.md b/docs/build/clarinet-integrations/stacks.js-integration.md similarity index 100% rename from docs/reference/clarinet-integrations/stacks.js-integration.md rename to docs/build/clarinet-integrations/stacks.js-integration.md diff --git a/docs/reference/clarinet-integrations/vscode-extension.md b/docs/build/clarinet-integrations/vscode-extension.md similarity index 100% rename from docs/reference/clarinet-integrations/vscode-extension.md rename to docs/build/clarinet-integrations/vscode-extension.md diff --git a/docs/reference/clarinet-js-sdk/integration-testing.md b/docs/build/clarinet-js-sdk/integration-testing.md similarity index 100% rename from docs/reference/clarinet-js-sdk/integration-testing.md rename to docs/build/clarinet-js-sdk/integration-testing.md diff --git a/docs/reference/clarinet-js-sdk/mainnet-execution-simulation.md b/docs/build/clarinet-js-sdk/mainnet-execution-simulation.md similarity index 100% rename from docs/reference/clarinet-js-sdk/mainnet-execution-simulation.md rename to docs/build/clarinet-js-sdk/mainnet-execution-simulation.md diff --git a/docs/reference/clarinet-js-sdk/overview.md b/docs/build/clarinet-js-sdk/overview.md similarity index 95% rename from docs/reference/clarinet-js-sdk/overview.md rename to docs/build/clarinet-js-sdk/overview.md index 435f0d9dd4..e61c886e9f 100644 --- a/docs/reference/clarinet-js-sdk/overview.md +++ b/docs/build/clarinet-js-sdk/overview.md @@ -4,7 +4,7 @@ description: Practical guide to testing smart contracts with the Clarinet JS SDK # Overview -

source: Hiro blog

+

source: Hiro blog

The Clarinet JS SDK provides a powerful testing framework for Clarity smart contracts. It integrates with Vitest to let you run comprehensive tests against a simulated blockchain environment. diff --git a/docs/reference/clarinet-js-sdk/unit-testing.md b/docs/build/clarinet-js-sdk/unit-testing.md similarity index 100% rename from docs/reference/clarinet-js-sdk/unit-testing.md rename to docs/build/clarinet-js-sdk/unit-testing.md diff --git a/docs/reference/clarinet/clarity-formatter.md b/docs/build/clarinet/clarity-formatter.md similarity index 100% rename from docs/reference/clarinet/clarity-formatter.md rename to docs/build/clarinet/clarity-formatter.md diff --git a/docs/reference/clarinet/contract-deployment.md b/docs/build/clarinet/contract-deployment.md similarity index 100% rename from docs/reference/clarinet/contract-deployment.md rename to docs/build/clarinet/contract-deployment.md diff --git a/docs/reference/clarinet/contract-interaction.md b/docs/build/clarinet/contract-interaction.md similarity index 99% rename from docs/reference/clarinet/contract-interaction.md rename to docs/build/clarinet/contract-interaction.md index f48648fa6e..1ef37e7165 100644 --- a/docs/reference/clarinet/contract-interaction.md +++ b/docs/build/clarinet/contract-interaction.md @@ -122,7 +122,7 @@ Advance the chain to test time-dependent logic: > **Tip: Console reference** > -> For a complete list of console commands, see the [CLI reference](cli-reference.md). +> For a complete list of console commands, see the [CLI reference](../../reference/clarinet/cli-reference.md). ## Common issues diff --git a/docs/reference/clarinet/faq.md b/docs/build/clarinet/faq.md similarity index 100% rename from docs/reference/clarinet/faq.md rename to docs/build/clarinet/faq.md diff --git a/docs/reference/clarinet/local-blockchain-development.md b/docs/build/clarinet/local-blockchain-development.md similarity index 100% rename from docs/reference/clarinet/local-blockchain-development.md rename to docs/build/clarinet/local-blockchain-development.md diff --git a/docs/reference/clarinet/overview.md b/docs/build/clarinet/overview.md similarity index 90% rename from docs/reference/clarinet/overview.md rename to docs/build/clarinet/overview.md index 484c25bac9..61c6fa9873 100644 --- a/docs/reference/clarinet/overview.md +++ b/docs/build/clarinet/overview.md @@ -8,11 +8,11 @@ description: >- Clarinet is the fastest way to build, test, and deploy smart contracts on the Stacks blockchain. It gives you a local devnet, REPL, testing framework, and debugging tools to ship high-quality Clarity code with confidence. -
+
## Key features -* [**Leverage a powerful CLI**](cli-reference.md) - Create new projects, manage your smart contracts and their dependencies using clarinet requirements, and interact with your code through the built-in REPL. +* [**Leverage a powerful CLI**](../../reference/clarinet/cli-reference.md) - Create new projects, manage your smart contracts and their dependencies using clarinet requirements, and interact with your code through the built-in REPL. * [**Write unit tests with the SDK**](../clarinet-js-sdk/unit-testing.md) - Use the Clarinet SDK to write unit tests in a familiar JS environment and validate contract behavior. * [**Run a private blockchain environment**](local-blockchain-development.md) - Spin up a local devnet with nodes, miners, and APIs so you can test and integrate your code. * [**VSCode extension**](../clarinet-integrations/vscode-extension.md) - Linter, step by step debugger, helps writing smart contracts (autocompletion, documentation etc). diff --git a/docs/reference/clarinet/project-development.md b/docs/build/clarinet/project-development.md similarity index 100% rename from docs/reference/clarinet/project-development.md rename to docs/build/clarinet/project-development.md diff --git a/docs/reference/clarinet/project-structure.md b/docs/build/clarinet/project-structure.md similarity index 100% rename from docs/reference/clarinet/project-structure.md rename to docs/build/clarinet/project-structure.md diff --git a/docs/reference/clarinet/quickstart.md b/docs/build/clarinet/quickstart.md similarity index 100% rename from docs/reference/clarinet/quickstart.md rename to docs/build/clarinet/quickstart.md diff --git a/docs/reference/clarinet/validation-and-analysis.md b/docs/build/clarinet/validation-and-analysis.md similarity index 100% rename from docs/reference/clarinet/validation-and-analysis.md rename to docs/build/clarinet/validation-and-analysis.md diff --git a/docs/reference/post-conditions/implementing-post-conditions.md b/docs/build/post-conditions/implementing-post-conditions.md similarity index 100% rename from docs/reference/post-conditions/implementing-post-conditions.md rename to docs/build/post-conditions/implementing-post-conditions.md diff --git a/docs/reference/post-conditions/overview.md b/docs/build/post-conditions/overview.md similarity index 100% rename from docs/reference/post-conditions/overview.md rename to docs/build/post-conditions/overview.md diff --git a/docs/reference/stacks-connect/broadcast-transactions.md b/docs/build/stacks-connect/broadcast-transactions.md similarity index 100% rename from docs/reference/stacks-connect/broadcast-transactions.md rename to docs/build/stacks-connect/broadcast-transactions.md diff --git a/docs/reference/stacks-connect/connect-wallet.md b/docs/build/stacks-connect/connect-wallet.md similarity index 100% rename from docs/reference/stacks-connect/connect-wallet.md rename to docs/build/stacks-connect/connect-wallet.md diff --git a/docs/reference/stacks-connect/message-signing.md b/docs/build/stacks-connect/message-signing.md similarity index 100% rename from docs/reference/stacks-connect/message-signing.md rename to docs/build/stacks-connect/message-signing.md diff --git a/docs/reference/stacks-connect/migration-guide.md b/docs/build/stacks-connect/migration-guide.md similarity index 100% rename from docs/reference/stacks-connect/migration-guide.md rename to docs/build/stacks-connect/migration-guide.md diff --git a/docs/reference/stacks-connect/wallet-support.md b/docs/build/stacks-connect/wallet-support.md similarity index 100% rename from docs/reference/stacks-connect/wallet-support.md rename to docs/build/stacks-connect/wallet-support.md diff --git a/docs/reference/stacks.js-integrations/pyth-oracle-integration.md b/docs/build/stacks.js-integrations/pyth-oracle-integration.md similarity index 100% rename from docs/reference/stacks.js-integrations/pyth-oracle-integration.md rename to docs/build/stacks.js-integrations/pyth-oracle-integration.md diff --git a/docs/reference/stacks.js-integrations/react-native-integration.md b/docs/build/stacks.js-integrations/react-native-integration.md similarity index 100% rename from docs/reference/stacks.js-integrations/react-native-integration.md rename to docs/build/stacks.js-integrations/react-native-integration.md diff --git a/docs/reference/stacks.js/accounts-and-addresses.md b/docs/build/stacks.js/accounts-and-addresses.md similarity index 100% rename from docs/reference/stacks.js/accounts-and-addresses.md rename to docs/build/stacks.js/accounts-and-addresses.md diff --git a/docs/reference/stacks.js/address-validation.md b/docs/build/stacks.js/address-validation.md similarity index 100% rename from docs/reference/stacks.js/address-validation.md rename to docs/build/stacks.js/address-validation.md diff --git a/docs/reference/stacks.js/build-transactions.md b/docs/build/stacks.js/build-transactions.md similarity index 100% rename from docs/reference/stacks.js/build-transactions.md rename to docs/build/stacks.js/build-transactions.md diff --git a/docs/reference/stacks.js/contract-calls.md b/docs/build/stacks.js/contract-calls.md similarity index 100% rename from docs/reference/stacks.js/contract-calls.md rename to docs/build/stacks.js/contract-calls.md diff --git a/docs/reference/stacks.js/contract-deployment.md b/docs/build/stacks.js/contract-deployment.md similarity index 100% rename from docs/reference/stacks.js/contract-deployment.md rename to docs/build/stacks.js/contract-deployment.md diff --git a/docs/reference/stacks.js/encoding-and-decoding.md b/docs/build/stacks.js/encoding-and-decoding.md similarity index 100% rename from docs/reference/stacks.js/encoding-and-decoding.md rename to docs/build/stacks.js/encoding-and-decoding.md diff --git a/docs/reference/stacks.js/network-configuration.md b/docs/build/stacks.js/network-configuration.md similarity index 100% rename from docs/reference/stacks.js/network-configuration.md rename to docs/build/stacks.js/network-configuration.md diff --git a/docs/reference/stacks.js/networks.md b/docs/build/stacks.js/networks.md similarity index 94% rename from docs/reference/stacks.js/networks.md rename to docs/build/stacks.js/networks.md index 71e1e69ceb..c2faabd293 100644 --- a/docs/reference/stacks.js/networks.md +++ b/docs/build/stacks.js/networks.md @@ -4,7 +4,7 @@ Typically, we speak of `mainnet` and `testnet` as the networks of Stacks. Most w As the name suggests, `testnet` is a public network for testing. It's a separate blockchain state that holds test tokens, which have no value. -For completeness we also mention `devnet`. This isn't "one" network, but how developers refer to ephemeral local networks used for testing. It is the same as `testnet`, but for local development. [Learn more](../clarinet/local-blockchain-development.md). +For completeness we also mention `devnet`. This isn't "one" network, but how developers refer to ephemeral local networks used for testing. It is the same as `testnet`, but for local development. [Learn more](../../build/clarinet/local-blockchain-development.md). ## Setting the network diff --git a/docs/reference/stacks.js/overview.md b/docs/build/stacks.js/overview.md similarity index 89% rename from docs/reference/stacks.js/overview.md rename to docs/build/stacks.js/overview.md index 993910ca03..9ffa2b686c 100644 --- a/docs/reference/stacks.js/overview.md +++ b/docs/build/stacks.js/overview.md @@ -1,6 +1,6 @@ # Overview -

source: Hiro blog

+

source: Hiro blog

## Overview diff --git a/docs/reference/stacks.js/private-keys.md b/docs/build/stacks.js/private-keys.md similarity index 100% rename from docs/reference/stacks.js/private-keys.md rename to docs/build/stacks.js/private-keys.md diff --git a/docs/reference/stacks.js/read-only-calls.md b/docs/build/stacks.js/read-only-calls.md similarity index 100% rename from docs/reference/stacks.js/read-only-calls.md rename to docs/build/stacks.js/read-only-calls.md diff --git a/docs/reference/stacks.js/unit-conversion.md b/docs/build/stacks.js/unit-conversion.md similarity index 100% rename from docs/reference/stacks.js/unit-conversion.md rename to docs/build/stacks.js/unit-conversion.md diff --git a/docs/reference/SUMMARY.md b/docs/reference/SUMMARY.md index ba1a098fc1..85105413d5 100644 --- a/docs/reference/SUMMARY.md +++ b/docs/reference/SUMMARY.md @@ -15,68 +15,13 @@ ## Clarinet -* [Overview](clarinet/overview.md) -* [Quickstart](clarinet/quickstart.md) -* [Project Structure](clarinet/project-structure.md) -* [Project Development](clarinet/project-development.md) -* [Contract Interaction](clarinet/contract-interaction.md) -* [Validation and Analysis](clarinet/validation-and-analysis.md) -* [Clarity Formatter](clarinet/clarity-formatter.md) -* [Local Blockchain Development](clarinet/local-blockchain-development.md) -* [Contract Deployment](clarinet/contract-deployment.md) * [CLI Reference](clarinet/cli-reference.md) -* [FAQ](clarinet/faq.md) ## Clarinet JS SDK -* [Overview](clarinet-js-sdk/overview.md) -* [Unit Testing](clarinet-js-sdk/unit-testing.md) -* [Integration Testing](clarinet-js-sdk/integration-testing.md) -* [Mainnet Execution Simulation](clarinet-js-sdk/mainnet-execution-simulation.md) * [SDK Reference](clarinet-js-sdk/sdk-reference.md) * [Browser SDK Reference](clarinet-js-sdk/browser-sdk-reference.md) -## Clarinet Integrations - -* [Pyth Oracle Integration](clarinet-integrations/pyth-oracle-integration.md) -* [Chainhook Integration](clarinet-integrations/chainhook-integration.md) -* [Stacks.js Integration](clarinet-integrations/stacks.js-integration.md) -* [sBTC Integration](clarinet-integrations/sbtc-integration.md) -* [VSCode Extension](clarinet-integrations/vscode-extension.md) - -## Stacks.js - -* [Overview](stacks.js/overview.md) -* [Accounts & Addresses](stacks.js/accounts-and-addresses.md) -* [Private Keys](stacks.js/private-keys.md) -* [Networks](stacks.js/networks.md) -* [Read Only Calls](stacks.js/read-only-calls.md) -* [Build Transactions](stacks.js/build-transactions.md) -* [Contract Calls](stacks.js/contract-calls.md) -* [Contract Deployment](stacks.js/contract-deployment.md) -* [Address Validation](stacks.js/address-validation.md) -* [Encoding & Decoding](stacks.js/encoding-and-decoding.md) -* [Network Configuration](stacks.js/network-configuration.md) -* [Unit Conversion](stacks.js/unit-conversion.md) - -## Stacks Connect - -* [Connect Wallet](stacks-connect/connect-wallet.md) -* [Broadcast Transactions](stacks-connect/broadcast-transactions.md) -* [Message Signing](stacks-connect/message-signing.md) -* [Migration Guide](stacks-connect/migration-guide.md) -* [Wallet Support](stacks-connect/wallet-support.md) - -## Post-Conditions - -* [Overview](post-conditions/overview.md) -* [Implementing Post Conditions](post-conditions/implementing-post-conditions.md) - -## Stacks.js Integrations - -* [Pyth Oracle Integration](stacks.js-integrations/pyth-oracle-integration.md) -* [React Native Integration](stacks.js-integrations/react-native-integration.md) - ## Stacks.js References * [@stacks/network](stacks.js-references/stacks-network.md)