Skip to content

Commit f113b39

Browse files
eric-stacksgitbook-bot
authored andcommitted
GITBOOK-21: adding an intro page for Get Started
1 parent d8e4806 commit f113b39

File tree

14 files changed

+1018
-893
lines changed

14 files changed

+1018
-893
lines changed
418 KB
Loading

docs/build/README.md

Lines changed: 28 additions & 833 deletions
Large diffs are not rendered by default.

docs/build/SUMMARY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Get Started
44

5-
* [Developer Quickstart](README.md)
5+
* [Introduction](README.md)
6+
* [Why Build with Stacks](get-started/why-build-with-stacks.md)
7+
* [Developer Quickstart](get-started/developer-quickstart.md)
68
* [Clarity Crash Course](get-started/clarity-crash-course.md)
79
* [Create Tokens](get-started/create-tokens/README.md)
810
* [Creating a NFT](get-started/create-tokens/creating-a-nft.md)
911
* [Creating a FT](get-started/create-tokens/creating-a-ft.md)
10-
* [Testing Smart Contracts](get-started/testing-smart-contracts/README.md)
1112
* [Build a Frontend](get-started/build-a-frontend/README.md)
1213
* [Post Conditions with Stacks.js](get-started/build-a-frontend/post-conditions-with-stacks.js.md)
1314
* [Authentication with Stacks.js](get-started/build-a-frontend/authentication-with-stacks.js.md)

docs/build/get-started/clarity-crash-course.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Clarity Crash Course
22

3-
## Clarity Crash Course
3+
## Intro
44

55
This is designed for people with some programming experience who are new to Clarity. You don't need prior smart contract development experience, but if you have experience with languages like Solidity, you'll pick this up quickly.
66

77
Once you've familiarized yourself with the language, consider the book [Clarity of Mind](https://book.clarity-lang.org/title-page.html) or the course [Clarity Universe](https://clarity-lang.org/universe) to continue your learning.
88

9+
{% hint style="info" %}
10+
Clarity is developed as a joint effort of [Hiro PBC](https://hiro.so/), [Algorand](http://algorand.com/), and various other stakeholders, that originally targets the Stacks blockchain.
11+
{% endhint %}
12+
913
### Your First Clarity Smart Contract
1014

1115
We're going to build a basic Clarity smart contract using [Clarity Tools](https://clarity.tools/code/new), so you won't have to install anything for this introduction. Visit that link and it will open up a new contract for you.
@@ -16,7 +20,7 @@ The initial example contains comments (two semicolons) and a public function dec
1620

1721
{% stepper %}
1822
{% step %}
19-
### Understanding a simple expression
23+
#### Understanding a simple expression
2024

2125
We can think of some constructs as function calls. For example:
2226

@@ -28,13 +32,13 @@ You can refer to the [`define-read-only`](https://docs.stacks.co/docs/write-smar
2832
{% endstep %}
2933

3034
{% step %}
31-
### Everything is an expression
35+
#### Everything is an expression
3236

3337
Clarity treats everything as expressions inside expressions. Function definitions are calls to built-in functions; the function body is an expression. This uniformity helps reasoning about programs in Clarity.
3438
{% endstep %}
3539

3640
{% step %}
37-
### Use LISP-like nesting
41+
#### Use LISP-like nesting
3842

3943
Expect nested parentheses and expressions. You’ll often read code as lists inside lists, where each parentheses-enclosed group represents a call or expression.
4044
{% endstep %}
@@ -88,9 +92,27 @@ In Clarity, there are public, private, and read-only functions:
8892
* (add-number 5)\
8993
Calls the function with parameter 5 (this is how you can invoke the function in an interactive environment like Clarity Tools).
9094

95+
***
96+
97+
### Testing Your Clarity Contract
98+
99+
{% hint style="danger" %}
100+
Smart contracts are immutable once deployed. Bugs are permanent. Test them thoroughly.
101+
{% endhint %}
102+
103+
* [Rendezvous Fuzz Testing](../rendezvous/overview.md): Use Rendezvous to hammer your contract with random inputs. It helps expose edge cases and vulnerabilities.
104+
* [Unit Testing in Clarinet](/broken/pages/xKpkZWiNCO3dwHoA9AeB): Unit testing verifies that individual contract functions behave as expected. 
105+
106+
***
107+
108+
### Additional Resources
109+
91110
This brief overview should get your feet wet with Clarity. For deeper learning, we recommend:
92111

93-
* The [Clarity Book](https://book.clarity-lang.org/title-page.html)
112+
* [Clarity Book](https://book.clarity-lang.org/title-page.html)
94113
* [Clarity Universe](https://clarity-lang.org/universe)
114+
* \[[Stacks YT](https://youtu.be/hFqH1bJEvnw?si=yQADCvRNNjotuAga)] How Stacks' Language Clarity Enables Next Gen Smart Contracts
115+
* \[[StacksDevs YT](https://www.youtube.com/watch?v=WZe1DgJ1w-E)] How Stacks’ Smart Contract Language Prevents Exploitation
116+
* \[[Chainlink YT](https://youtu.be/OAVwd6SNJVU?si=UgfjmisBRbIYv27U)] Marvin Janssen: Clarity Smart Contracts for Stacks 
95117

96118
If you prefer jumping into reference material and examples, the Clarity docs contain guides and sample contracts to explore.

0 commit comments

Comments
 (0)