https://github.com/stacks-network/docs

Unleash Bitcoin's full potential with decentralized apps and smart contracts. The documentation covers key aspects of the Stacks network and technology and provides tutorials and other helpful content for developers.
https://github.com/stacks-network/docs

blockchain clarity decentralized docs documentation smart-contracts stacks web3

Last synced: 15 days ago
JSON representation

Unleash Bitcoin's full potential with decentralized apps and smart contracts. The documentation covers key aspects of the Stacks network and technology and provides tutorials and other helpful content for developers.

• Host: GitHub
• URL: https://github.com/stacks-network/docs
• Owner: stacks-network
• License: cc0-1.0
• Created: 2018-08-22T16:05:32.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T20:20:51.000Z (17 days ago)
• Last Synced: 2024-10-24T03:24:03.062Z (17 days ago)
• Topics: blockchain, clarity, decentralized, docs, documentation, smart-contracts, stacks, web3
• Language: JavaScript
• Homepage: https://docs.stacks.co
• Size: 355 MB
• Stars: 158
• Watchers: 35
• Forks: 238
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Start Here

{% hint style="info" %}

Note that these docs describe how Stacks _currently_ works pre-Nakamoto. There is a significant undertaking to improve the functionality of the chain that will change some of this called the Nakamoto Release. To learn more about how Stacks will work after Nakamoto, check out the Nakamoto Upgrade section.

{% endhint %}

## Stacks Docs

**Stacks is the leading Bitcoin L2, bringing smart contract functionality to Bitcoin, without modifying Bitcoin itself.**

These docs serve as:

1. An introduction to Stacks (what it is, why you should care, how to build Bitcoin apps with it),

2. A reference guide to various aspects of the Stacks ecosystem

3. A collection of tutorials and code samples to help you learn and build

They are divided up into several sections:

### Nakamoto Upgrade

There is currently a major upgrade to Stacks underway called the Nakamoto Release. This will bring significant improvements to both security and speed. Since this work is still in-progress, there is a dedicated section describing how it works. Once the release is live on mainnet, these docs will be adjusted to reflect the way the chain works.

### Stacks 101

If you are interested in the basics of how Stacks works, the Stacks 101 section contains the essential information to understand how everything works. Note that this section explains how Stacks operates pre-Nakamoto, and will be updated in conjunction with the release.

### Tutorials

Check out the Tutorials section to get some hands-on experience building on Bitcoin with Stacks.

### Clarity Reference

Clarity is the smart contract programming language used on the Stacks chain. This section is a reference for Clarity keywords and functions, as well as a quick tutorial for wrapping your head around the language.

### sBTC

sBTC is the upcoming trust-minimized Bitcoin peg system build on top of Stacks. This section will give you all the information you need to understand how it works. For tutorials on building with it, be sure to check out the tutorials section.

### In-Depth Technical Explanations

Finally, for those of you interested in diving deep into how Stacks works, the in-depth technical explanations are drawn from the SIPs, the documents formally outlining the technical functionality of Stacks. This will get you as much information on how things work outside of reading the source code yourself.

### AI-Powered Semantic Search

Looking for something specific? These docs are integrated with AI-powered semantic search, hit `Cmd/Ctrl + K` to open up the search box and ask the docs whatever you like.