GithubHelp home page GithubHelp logo

c0d3rk1d / stacks-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from stacks-network/docs

0.0 0.0 0.0 177.83 MB

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.

Home Page: https://docs.stacks.co

License: Creative Commons Zero v1.0 Universal

Shell 0.93% JavaScript 95.67% MDX 3.40%

stacks-docs's Introduction

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

For all you developers, we have a collection of tutorials here for you to explore, both hosted here on the docs site and some others from the community.

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.

stacks-docs's People

Contributors

adamdunkels avatar agraebe avatar alexkeating avatar aulneau avatar bot-translations avatar c0d3rk1d avatar charliec3 avatar criadoperez avatar cuevasm avatar d0minicw0ng avatar dependabot[bot] avatar diwakergupta avatar friedger avatar ginaabrams avatar harinirajan397 avatar homiebtc avatar hstove avatar jdbender66 avatar jhammond2012 avatar johndmulhausen avatar kantai avatar kantai-robot avatar kenrogers avatar kyranjamie avatar markmhendrickson avatar pgray-hiro avatar reedrosenbluth avatar whoabuddy avatar wileyj avatar yknl avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.