diff --git a/docs/build/README.md b/docs/build/README.md index 8edb5bdb1b..cc859e10bb 100644 --- a/docs/build/README.md +++ b/docs/build/README.md @@ -96,7 +96,7 @@ There is also a subsection of example Clarity contracts where you'll find **star We all have different styles of learning. If you've already got a good concept of web3 fundamentals and want to get a quick taste of what the DevEx is like on Stacks, then check out the [Developer Quickstart](get-started/developer-quickstart.md). Or find the path that clicks for you — and if bandwidth allows, tackle them all! -

Try the Developer Quickstart

Your 0→1 guide for building a Clarity contract and app on Stacks.developer-quickstart.md

Start Learning Clarity

An easy starting point for learning smart contracts.clarity-crash-course.md

Bitcoin Primer Tutorial

A comprehensive end-to-end experience to building full-stack dApps on Bitcoin.Bitcoin Primer

Earn a Stacks Developer Degree

A hands-on Stacks bootcamp by LearnWeb3.https://learnweb3.io/degrees/stacks-developer-degree/

Watch Our Hands-On Videos

Developer insights and workshops from the Stacks ecosystemhttps://www.youtube.com/@stacks-developers

Clarity Development Using Clarinet

The smart contract toolkit for StacksBroken link
+

Try the Developer Quickstart

Your 0→1 guide for building a Clarity contract and app on Stacks.developer-quickstart.md

Start Learning Clarity

An easy starting point for learning smart contracts.clarity-crash-course.md

Bitcoin Primer Tutorial

A comprehensive end-to-end experience to building full-stack dApps on Bitcoin.Bitcoin Primer

Earn a Stacks Developer Degree

A hands-on Stacks bootcamp by LearnWeb3.https://learnweb3.io/degrees/stacks-developer-degree/

Watch Our Hands-On Videos

Developer insights and workshops from the Stacks ecosystemhttps://www.youtube.com/@stacks-developers

Clarity Development Using Clarinet

The smart contract toolkit for Stacksclarinet/overview.md
@@ -107,7 +107,7 @@ We all have different styles of learning. If you've already got a good concept o | If you are… | First check out... | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Completely new to building with Stacks | [Developer Quickstart](get-started/developer-quickstart.md) | -| Learning smart contract development | [Clarity Crash Course](get-started/clarity-crash-course.md), [Learn Clarinet](/broken/pages/UK5Kgh2MHLoQvfoFVnLr) | +| Learning smart contract development | [Clarity Crash Course](get-started/clarity-crash-course.md), [Learn Clarinet](clarinet/overview.md) | | Preferring a structured, guided course that shows you every step to build full-stack apps | [Stacks Developer Degree](https://learnweb3.io/degrees/stacks-developer-degree/), [Bitcoin Primer](https://app.gitbook.com/s/skGYu79qDNfITOqDNU3s/bitcoin-primer/introduction), [EasyA](https://www.easya.io/challenges/stacks) | | Wanting to integrate sBTC in your app | [sBTC guides](more-guides/sbtc/) | | Launching a token | [Create Tokens](get-started/create-a-token/) | diff --git a/docs/build/get-started/path-to-production.md b/docs/build/get-started/path-to-production.md index 7d8c118202..7f5a932858 100644 --- a/docs/build/get-started/path-to-production.md +++ b/docs/build/get-started/path-to-production.md @@ -39,7 +39,7 @@ To ensure your app or smart contract is production-ready, we pulled together a s {% step %} ### Specific Clarity/Stacks.js best practices -* [**Post-conditions**](/broken/pages/0KPrPPKItMGZZL2u4tiF): Post conditions are an additional safety feature built into the Stacks chain itself that help to protect end users. Rather than being a function of Clarity smart contracts, they are implemented on the client side and meant to be an additional failsafe against malicious contracts. +* [**Post-conditions**](../post-conditions/overview.md): Post conditions are an additional safety feature built into the Stacks chain itself that help to protect end users. Rather than being a function of Clarity smart contracts, they are implemented on the client side and meant to be an additional failsafe against malicious contracts. * [**Usage of `tx-sender` vs `contract-caller`**](https://www.setzeus.com/public-blog-post/clarity-carefully-tx-sender) : The usage of `tx-sender` versus another Clarity keyword, `contract-caller` , is always a tricky concept because it determines who actually initiated the transaction versus who invoked the current function. Both of them can have certain implications on security based on the context of your code. * Write meaningful error codes to improve error handling * Adopt a modular contract design approach @@ -68,7 +68,7 @@ While contracts are immutable once deployed, you can deploy new versions of your ### Implement comprehensive testing tools * [**Unit tests**](../clarinet/testing-with-clarinet-sdk.md) -* [**Fuzzing**](/broken/pages/h06OJd7RHqUk2Dq7DHwJ) +* [**Fuzzing**](../rendezvous/overview.md) * [**Devnet**](../clarinet/local-blockchain-development.md) {% endstep %} diff --git a/docs/build/more-guides/bridging-usdcx.md b/docs/build/more-guides/bridging-usdcx.md index 1074fee294..12e5defdb7 100644 --- a/docs/build/more-guides/bridging-usdcx.md +++ b/docs/build/more-guides/bridging-usdcx.md @@ -31,7 +31,7 @@ ### Key Tools To Use * [viem](https://viem.sh/) - A Typescript-first library that interfaces with Ethereum. -* [stacks.js](/broken/pages/dH5waQhE6Vb7rhcrUG7z) - A js library that helps developers build Stacks apps by handling transactions, wallet authentication, and smart contract interactions. +* [Stacks.js](../stacks.js/overview.md) - A JavaScript library that helps developers build Stacks apps by handling transactions, wallet authentication, and smart contract interactions. * [Circle Faucet](https://faucet.circle.com/) - Get testnet USDC * [Ethereum Sepolia faucet](https://cloud.google.com/application/web3/faucet/ethereum/sepolia) - Get testnet ETH * [USDCx API](https://app.gitbook.com/s/GVj1Z9vMuEOMe7oH7Wnq/api/usdcx-bridge) - Fetch deposit and withdrawal status diff --git a/docs/build/more-guides/sbtc/sbtc-builder-quickstart.md b/docs/build/more-guides/sbtc/sbtc-builder-quickstart.md index 6bc393950a..b191cf28e6 100644 --- a/docs/build/more-guides/sbtc/sbtc-builder-quickstart.md +++ b/docs/build/more-guides/sbtc/sbtc-builder-quickstart.md @@ -22,8 +22,8 @@ In order to get the most from this quickstart, you should familiarize yourself w * [Stacks Developer Quickstart](https://app.gitbook.com/o/hoh4mQXTl8NvI3cETroY/s/Zz9BLmTU9oydDpL3qiUh/) - For a quick holistic introduction to the Stacks development process, tools, and fundamentals * [Clarity Crash Course](../../get-started/clarity-crash-course.md) - For a quick introduction to Clarity -* [Clarinet Docs](/broken/pages/UK5Kgh2MHLoQvfoFVnLr) -* [Stacks.js Docs](/broken/pages/dH5waQhE6Vb7rhcrUG7z) +* [Clarinet Docs](../../clarinet/overview.md) +* [Stacks.js Docs](../../stacks.js/overview.md) #### Local with Clarinet diff --git a/docs/press-and-reports/press-and-top-links/2024/README.md b/docs/press-and-reports/press-and-top-links/2024/README.md index ba259fbbf3..e8b1c3c3a3 100644 --- a/docs/press-and-reports/press-and-top-links/2024/README.md +++ b/docs/press-and-reports/press-and-top-links/2024/README.md @@ -8,50 +8,50 @@ description: >- For weekly stories delivered to your inbox, subscribe to [Stacks Snacks](https://stackssnacks.com/). For quarterly ecosystem recaps, subscribe to the [Stacks Foundation newsletter](https://newsletters.stacks.org/). -{% content-ref url="/broken/pages/cd2e8707fe40b8a43e40923a688434e9aaf4922e" %} -[Broken link](/broken/pages/cd2e8707fe40b8a43e40923a688434e9aaf4922e) +{% content-ref url="january-2024.md" %} +[January 2024](january-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/29b9f8cda45db86fe5031ee567341583324e2f6b" %} -[Broken link](/broken/pages/29b9f8cda45db86fe5031ee567341583324e2f6b) +{% content-ref url="february-2024.md" %} +[February 2024](february-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/e7761aa2c81d3c8245dbc54570199f1aebd91325" %} -[Broken link](/broken/pages/e7761aa2c81d3c8245dbc54570199f1aebd91325) +{% content-ref url="march-2024.md" %} +[March 2024](march-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/bbb9712e169fccb44833d8d9f0d98ad2bccd62f2" %} -[Broken link](/broken/pages/bbb9712e169fccb44833d8d9f0d98ad2bccd62f2) +{% content-ref url="april-2024.md" %} +[April 2024](april-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/aec6e9d8a50d144e48a1dfdc8af0e834cd9af457" %} -[Broken link](/broken/pages/aec6e9d8a50d144e48a1dfdc8af0e834cd9af457) +{% content-ref url="may-2024.md" %} +[May 2024](may-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/629cc20de749db943380bddf1d69842a2863033c" %} -[Broken link](/broken/pages/629cc20de749db943380bddf1d69842a2863033c) +{% content-ref url="june-2024.md" %} +[June 2024](june-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/cf07211cab8be8b227dee91931874e3fe5792b8d" %} -[Broken link](/broken/pages/cf07211cab8be8b227dee91931874e3fe5792b8d) +{% content-ref url="july-2024.md" %} +[July 2024](july-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/1fc9a3503ea5c373fb758dc9be7401b5f70501d4" %} -[Broken link](/broken/pages/1fc9a3503ea5c373fb758dc9be7401b5f70501d4) +{% content-ref url="august-2024.md" %} +[August 2024](august-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/db2a454141ac04ca7ea4bc2666e5af5fab4deb68" %} -[Broken link](/broken/pages/db2a454141ac04ca7ea4bc2666e5af5fab4deb68) +{% content-ref url="september-2024.md" %} +[September 2024](september-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/4050fecb50c952b844915fafb1b214eb349e1931" %} -[Broken link](/broken/pages/4050fecb50c952b844915fafb1b214eb349e1931) +{% content-ref url="october-2024.md" %} +[October 2024](october-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/68a55e4003881342d50a527d6f8e683cd5803dde" %} -[Broken link](/broken/pages/68a55e4003881342d50a527d6f8e683cd5803dde) +{% content-ref url="november-2024.md" %} +[November 2024](november-2024.md) {% endcontent-ref %} -{% content-ref url="/broken/pages/bd6ef1fe15c0f8e10163ba8857053effe9eb20da" %} -[Broken link](/broken/pages/bd6ef1fe15c0f8e10163ba8857053effe9eb20da) +{% content-ref url="december-2024.md" %} +[December 2024](december-2024.md) {% endcontent-ref %} diff --git a/docs/press-and-reports/press-and-top-links/2025/README.md b/docs/press-and-reports/press-and-top-links/2025/README.md index 0a4fd73593..c82d3c10a9 100644 --- a/docs/press-and-reports/press-and-top-links/2025/README.md +++ b/docs/press-and-reports/press-and-top-links/2025/README.md @@ -2,4 +2,46 @@ For weekly stories delivered to your inbox, subscribe to [Stacks Snacks](https://stackssnacks.com/). For quarterly ecosystem recaps, subscribe to the [Stacks Foundation newsletter](https://newsletters.stacks.org/). -
IssueTarget
january-2024.mdBroken link
february-2025.mdBroken link
march-2025.mdBroken link
march-2025-1.mdBroken link
march-2025-2.mdBroken link
june-2025.mdBroken link
june-2025-1.mdBroken link
june-2025-2.mdBroken link
june-2025-2-1.mdBroken link
+{% content-ref url="january-2025.md" %} +[January 2025](january-2025.md) +{% endcontent-ref %} + +{% content-ref url="february-2025.md" %} +[February 2025](february-2025.md) +{% endcontent-ref %} + +{% content-ref url="march-2025.md" %} +[March 2025](march-2025.md) +{% endcontent-ref %} + +{% content-ref url="april-2025.md" %} +[April 2025](april-2025.md) +{% endcontent-ref %} + +{% content-ref url="may-2025.md" %} +[May 2025](may-2025.md) +{% endcontent-ref %} + +{% content-ref url="june-2025.md" %} +[June 2025](june-2025.md) +{% endcontent-ref %} + +{% content-ref url="july-2025.md" %} +[July 2025](july-2025.md) +{% endcontent-ref %} + +{% content-ref url="august-2025.md" %} +[August 2025](august-2025.md) +{% endcontent-ref %} + +{% content-ref url="september-2025.md" %} +[September 2025](september-2025.md) +{% endcontent-ref %} + +{% content-ref url="september-2025-1.md" %} +[September 2025 Update 1](september-2025-1.md) +{% endcontent-ref %} + +{% content-ref url="september-2025-2.md" %} +[September 2025 Update 2](september-2025-2.md) +{% endcontent-ref %} diff --git a/docs/reference/README.md b/docs/reference/README.md index 39137d170d..95a4a05bce 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -10,4 +10,4 @@ If you’re an experienced Stacks developer looking to quickly reference a speci ### Looking for references on... -

APIs

Endpoints for interacting with Stacks nodes, signers, sBTC bridge, and the USDCx bridgeBroken link

Clarity

Definitions for types, functions, and keywordsBroken link

Clarinet

CLI commands for developing and deploying contractsBroken link

Clarinet JS SDK

Test and simulate contracts in JavaScriptBroken link

Rendezvous

Property-based testing and fuzzing for ClarityBroken link

Stacks.js

Definitions for functions and types when building frontend/backend scriptsBroken link
+

APIs

Endpoints for interacting with Stacks nodes, signers, sBTC bridge, and the USDCx bridgeapi/stacks-blockchain-api/README.md

Clarity

Definitions for types, functions, and keywordsclarity/functions.md

Clarinet

CLI commands for developing and deploying contractsclarinet/cli-reference.md

Clarinet JS SDK

Test and simulate contracts in JavaScriptclarinet-js-sdk/sdk-reference.md

Rendezvous

Property-based testing and fuzzing for Clarityrendezvous/reference.md

Stacks.js

Definitions for functions and types when building frontend/backend scriptsstacks.js/stacks-wallet/README.md
diff --git a/docs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.md b/docs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.md index f413ee2125..05707ed91a 100644 --- a/docs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.md +++ b/docs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.md @@ -6,7 +6,7 @@ The Nakamoto release brings many new capabilities and improvements to the Stacks blockchain by focusing on a set of core advancements: improving transaction speed, enhancing finality guarantees for transactions, mitigating Bitcoin miner MEV (miner extractable value) opportunities that affect PoX, and boosting robustness against chain reorganizations. This strategic upgrade aims to solidify trust in the Stacks network, offer greater alignment with Bitcoin's immutable nature, and foster an environment ripe for advanced Decentralized Finance (DeFi) applications. The expected outcome is a versatile, scalable, and secure platform that closely integrates with, yet distinctly enhances, the Bitcoin ecosystem. -Learn more: [Broken link](/broken/pages/fac008cad2409afc8de86501f205ee51e148b5af "mention") +Learn more: [What is the Nakamoto Release?](../what-is-the-nakamoto-release.md) @@ -27,7 +27,7 @@ The main thing exchanges will notice when the Nakamoto rollout is complete is th ### Resources * [Testnet documentation](https://docs.stacks.co/nakamoto-upgrade/nakamoto) -* [API documentation](https://docs.hiro.so/nakamoto/stacks-js) +* [API documentation](../../api/stacks-mesh-api/README.md) * [Stacks Core Binaries](https://github.com/stacks-network/stacks-core/releases/latest) * [Stacks Signer Binary](https://github.com/stacks-network/stacks-core/releases/tag/signer-3.1.0.0.5.0) * [Stacks Core Docker Images](https://hub.docker.com/r/blockstack/stacks-core/tags?page=1\&name=3.1.0.0.5) diff --git a/docs/reference/node-operations/signer-configuration.md b/docs/reference/node-operations/signer-configuration.md index ed5e7439a5..9e1e1bb8da 100644 --- a/docs/reference/node-operations/signer-configuration.md +++ b/docs/reference/node-operations/signer-configuration.md @@ -24,7 +24,7 @@ The signer configuration file is a TOML file that contains the configuration opt #### Example Configs -Below are sample configuration files for running a Stacks node and signer provided in one place for convenience. You'll need to modify some of these according to the [How to Run a Signer](/broken/pages/261edd335c0b98fb052ad55906fbf90832800453) doc. +Below are sample configuration files for running a Stacks node and signer provided in one place for convenience. You'll need to modify some of these according to the [How to Run a Signer](../../operate/run-a-signer/README.md) doc. #### Testnet Signer @@ -63,9 +63,9 @@ stacks_private_key = "$your_stacks_private_key" Note that the `block_proposal_token` field has changed to `auth_token` in the Stacks node configuration file. {% endhint %} -This is the configuration you'll need to run a Stacks follower node if you are also running a signer. Be sure to change the commented lines to the appropriate data for your setup. If you are not familiar with the process of setting up a signer, be sure to follow the [How to Run a Signer](/broken/pages/261edd335c0b98fb052ad55906fbf90832800453) guide. +This is the configuration you'll need to run a Stacks follower node if you are also running a signer. Be sure to change the commented lines to the appropriate data for your setup. If you are not familiar with the process of setting up a signer, be sure to follow the [How to Run a Signer](../../operate/run-a-signer/README.md) guide. -An overview of all Stacks node configuration options can be found in the [Stacks Node Configuration](/broken/pages/79a6d21c88b879210b9f2036268ace38ae6a02af) doc. +An overview of all Stacks node configuration options can be found in the [Stacks Node Configuration](https://docs.stacks.co/reference/stacks-node-configuration) doc. Additions necessary specifically to run a signer are the `[connection_options]` and `[[events_observer]]` sections and the `stacker = true` line. There are also a few comments detailing other lines that need to change. diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 89deaacb3d..ef2d429dd1 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -12,4 +12,4 @@ This tutorials section consists of end-to-end guides on building complete applic Our tutorials section has launched with its first complete tutorial: the Bitcoin Primer, which gives a holistic introduction to both Bitcoin and Stacks. Additional tutorials are in the works to walk through how to build different things with Stacks. -
Cover image
Bitcoin PrimerA high-level introduction to Bitcoin and how to expand its functionality with Stacks.Broken linkbitcoinprimertutorial.png
+
Cover image
Bitcoin PrimerA high-level introduction to Bitcoin and how to expand its functionality with Stacks.bitcoin-primer/introduction.mdbitcoinprimertutorial.png