diff --git a/docs/build/README.md b/docs/build/README.md index 8edb5bdb1b..8c26a06e80 100644 --- a/docs/build/README.md +++ b/docs/build/README.md @@ -1,5 +1,5 @@ --- -description: Build powerful apps, secured by Bitcoin. +description: Build powerful apps secured by Bitcoin. --- # Introduction @@ -10,9 +10,9 @@ description: Build powerful apps, secured by Bitcoin. New to building with Stacks? Check out these weekly virtual meets! -* **Stacks DevRel office hours**: Follow and enable notifications for [@StacksDevs](https://x.com/StacksDevs) on Twitter to catch alerts for our weekly livestreams every Thursday at 10am EST. Office Hours are the easiest way to stay in the loop on product drops, live demos, community builder spotlights, and more. Stay up-to-date with release discussions, real-time walkthroughs, and builder highlights that matter. -* **Clarity Working Group**: An open, developer-focused initiative dedicated to supporting builders across the Stacks ecosystem. The group brings together experienced Clarity engineers (“Clarity giga chads”), auditors, educators, grant project teams, and new developers to collaborate, learn, and advance smart contract development on Bitcoin. Check out the calendar [link](https://www.addevent.com/event/yc0x95fky8y4) to join every other Tuesday. -* **AI BTC Working Group:** Join the **AI BTC Working Group**'s (WG) weekly meeting on AIBTC's twitter account, where they delve into the exciting intersection of AI and Bitcoin. Check out the calendar [link](https://www.addevent.com/event/c3qjy462xr82) to join every Thursday. +* **Stacks DevRel office hours**: Follow and enable notifications for [@StacksDevs](https://x.com/StacksDevs) on Twitter to catch alerts for weekly livestreams every Thursday at 10am EST. Office Hours are the easiest way to stay up to date on product releases, live demos, community builder spotlights, and more. +* **Clarity Working Group**: An open, developer-focused initiative dedicated to supporting builders across the Stacks ecosystem. The group brings together experienced Clarity engineers, auditors, educators, grant teams, and new developers to collaborate, learn, and advance smart contract development on Bitcoin. Check out the calendar [link](https://www.addevent.com/event/yc0x95fky8y4) to join every other Tuesday. +* **AI BTC Working Group:** Join the AI BTC Working Group’s weekly meeting on AIBTC’s Twitter account, where they explore the intersection of AI and Bitcoin. Check out the calendar [link](https://www.addevent.com/event/c3qjy462xr82) to join every Thursday. @@ -22,7 +22,7 @@ description: Build powerful apps, secured by Bitcoin. Stackers is a community of people building on Bitcoin with Stacks. -The purpose of the Stackers community comes down to guided paths for learning and starting a project on Stacks, developer support from community members, and the best place to hear about new events, initiatives, and opportunities to build. +The purpose of the Stackers community is to provide guided learning paths, developer support, and a central place to discover new events, initiatives, and opportunities. Join the [Stackers](https://www.skool.com/stackers)! @@ -34,59 +34,53 @@ Stacks ranks #5 among all crypto ecosystems for new developers in 2025! \[source ### Hello, Builders 👋 -Stacks is a fast, low-cost, builder-friendly layer 2 network on Bitcoin. It’s built on Bitcoin, inheriting Bitcoin’s battle-tested security. By jumping into our docs, you’re joining the Stacks builder community that’s bringing a global onchain economy to Bitcoin. +Stacks is a fast, low-cost, builder-friendly layer 2 network on Bitcoin. It is built on Bitcoin, inheriting its battle-tested security. By exploring these docs, you are joining a global community building an onchain economy on Bitcoin. -If you're here on this page, hopefully you've already gotten a good sense of _what_ Stacks' purpose is, if not, head to the [Learn](https://app.gitbook.com/o/hoh4mQXTl8NvI3cETroY/s/H74xqoobupBWwBsVMJhK/) section. Or if you're still on the edge of _why_ you should build with Stacks, head to [Why Build with Stacks](get-started/readme/why-build-with-stacks.md). +If you're here, you likely already understand what Stacks is. If not, head to the [Learn](https://app.gitbook.com/o/hoh4mQXTl8NvI3cETroY/s/H74xqoobupBWwBsVMJhK/) section. If you're still deciding why to build with Stacks, check out [Why Build with Stacks](get-started/readme/why-build-with-stacks.md). *** ### How to use these docs -The Stacks documentation is organized into a set of top-level sections, each aligned to a distinct stage of a developer’s journey—from learning core concepts to building applications and operating infrastructure. +The Stacks documentation is organized into top-level sections aligned with each stage of a developer’s journey—from learning core concepts to building applications and operating infrastructure. {% tabs %} {% tab title="Learn" %} -**How does the Stacks network **_**actually**_** work?**\ -The [Learn](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/) section focuses on building a strong academic foundation. It explains how Stacks functions as a Bitcoin layer 2, providing clarity and context around the network’s design and mechanics. +**How does the Stacks network actually work?** +The [Learn](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/) section focuses on building a strong foundation. It explains how Stacks operates as a Bitcoin layer 2, providing clarity on its architecture and mechanics. -Topics include Proof of Transfer (PoX), Bitcoin finality, block production, the transaction lifecycle, and more. If you want a deep understanding of how Stacks anchors to Bitcoin and why it works the way it does, this is the best place to start. +Topics include Proof of Transfer (PoX), Bitcoin finality, block production, transaction lifecycle, and more. {% endtab %} {% tab title="Build" %} -**How do you build on Stacks?**\ -This section is for experienced developers, but are new to Stacks, who are in the exploratory phase of understanding the general workflow of building apps on Stacks. These guides focus on accomplishing specific tasks—writing contracts, integrating wallets, working with sBTC or USDC—without extensive explainers. +**How do you build on Stacks?** +This section is for experienced developers who are new to Stacks and are exploring the workflow of building applications. -It includes curated quick starts for smart contract development with Clarinet and frontend development with Stacks.js, along with step-by-step guides covering common use cases such as integrating sBTC, onboarding users, working with price oracles, and more. +It includes quickstarts for smart contracts using Clarinet and frontend development with Stacks.js, along with guides for integrating sBTC, onboarding users, and working with oracles. {% endtab %} {% tab title="Operate" %} -**How do you run Stacks infrastructure?**\ -The [Operate](https://app.gitbook.com/s/4cpTb2lbw0LAOuMHrvhA/run-a-node) section is designed for node operators and infrastructure providers. It covers how to run and manage Stacks nodes, signers, and miners. +**How do you run Stacks infrastructure?** +The [Operate](https://app.gitbook.com/s/4cpTb2lbw0LAOuMHrvhA/run-a-node) section is designed for node operators and infrastructure providers. It covers how to run and manage nodes, signers, and miners. -If you’re responsible for operating or maintaining Stacks-related infrastructure, this section contains the resources you’ll need. {% endtab %} {% tab title="Reference" %} -**Where do you look up technical details such as types, definitions, and configuration?**\ -The [Reference](https://app.gitbook.com/s/GVj1Z9vMuEOMe7oH7Wnq/node-operations/readme) section contains authoritative technical documentation for Stacks devtools and APIs. This includes function and type definitions for Clarity and Stacks.js, API endpoint schemas, and interactive API playgrounds. +**Where do you find technical details?** +The [Reference](https://app.gitbook.com/s/GVj1Z9vMuEOMe7oH7Wnq/node-operations/readme) section contains detailed documentation for devtools and APIs, including function definitions, schemas, and references. -If you’re an experienced Stacks developer looking to quickly reference a specific method, type, or API response, this section is built for fast lookup and precision. {% endtab %} {% tab title="Tutorials" %} -**Looking for a more guided, lesson-oriented experience?**\ -The [Tutorials](https://app.gitbook.com/s/skGYu79qDNfITOqDNU3s/) section is designed for complete beginner developers who want structured, long-form lessons rather than quick answers. +**Looking for guided learning?** +The [Tutorials](https://app.gitbook.com/s/skGYu79qDNfITOqDNU3s/) section provides step-by-step walkthroughs with deeper explanations to help you understand both how and why things work. -These tutorials provide step-by-step walkthroughs alongside in-depth explanations of the underlying concepts. The goal isn’t just to help you complete a task, but to help you understand _why_ things work the way they do as you build. - -If you’re a complete beginner and prefer a classroom-style, concept-driven learning experience—this section is the best place to start. {% endtab %} {% tab title="Cookbook" %} -**Looking for a specific code snippet?**\ -The [Cookbook](https://app.gitbook.com/s/uholC0CdufHxYs050O3V/) section is for developers beyond the exploratory phase who require a specific, concrete code solution quickly for an existing application.This section provides focused, reusable Clarity and Stacks.js code snippets that solve common problems or demonstrate specific patterns—designed to be referenced, copied, and adapted rather than read end-to-end. +**Looking for code snippets?** +The [Cookbook](https://app.gitbook.com/s/uholC0CdufHxYs050O3V/) section provides reusable Clarity and Stacks.js snippets for common use cases. -There is also a subsection of example Clarity contracts where you'll find **starter contracts** that demonstrate common patterns and best practices in Clarity, as well as **notable production contracts** currently used by popular Stacks applications. {% endtab %} {% endtabs %} @@ -94,34 +88,27 @@ There is also a subsection of example Clarity contracts where you'll find **star ### Pick your learning path -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
- +We all have different learning styles. If you want a quick introduction, check out the [Developer Quickstart](get-started/developer-quickstart.md). +

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 for 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 ecosystem.https://www.youtube.com/@stacks-developers

Clarity Development Using Clarinet

The smart contract toolkit for Stacks.Link currently unavailable
*** ### Who should use what -| 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) | -| 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/) | -| Interested in security / auditing / grants | [Stacks Bug Bounties](https://immunefi.com/bug-bounty/stacks/information/), [Stacks Foundation](https://stacks.org/grants) | -| Curious about current use cases | [Use Cases](get-started/use-cases/) | -| Searching for a complete list of devtools | [Stacks Devtools Catalog](stacks-devtools-catalog.md) | +| If you are… | First check out... | +|------------|------------------| +| Completely new | Developer Quickstart | +| Learning smart contracts | Clarity Crash Course | +| Want structured course | Stacks Developer Degree | +| Integrating sBTC | sBTC guides | +| Launching token | Create Tokens | *** ### Still got questions? -We know, it's a lot. But we, along with our large community, are always more than welcome to help you throughout your journey with Stacks. - -* [**Stacks Discord**](https://discord.gg/stacks): Connect with other developers and our team -* [**Stacks Forum**](https://forum.stacks.org/): Ask questions and share projects -* [**Stacks Twitter**](https://x.com/StacksDevs)**:** Follow us on Twitter and ask us questions there -* [**Stackers**](https://www.skool.com/stackers): A community to hear about new events, initiatives, and opportunities to build. +* Stacks Discord: https://discord.gg/stacks +* Stacks Forum: https://forum.stacks.org/ +* Stacks Twitter: https://x.com/StacksDevs +* Stackers: https://www.skool.com/stackers