-
Notifications
You must be signed in to change notification settings - Fork 266
docs: comprehensive documentation improvements across Learn, Build, Operate, and Reference sections #1828
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Dark-Brain07
wants to merge
11
commits into
stacks-network:master
Choose a base branch
from
Dark-Brain07:docs/comprehensive-improvements
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docs: comprehensive documentation improvements across Learn, Build, Operate, and Reference sections #1828
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
10a745f
docs(clarinet): add exit instructions, common mistakes, and next step…
Dark-Brain07 0d56548
docs(stacks.js): add package descriptions table and quick example to …
Dark-Brain07 eb40eea
docs(learn): add prerequisites section to Learn README for better onb…
Dark-Brain07 ee69168
docs(operate): add troubleshooting tips, community support, and healt…
Dark-Brain07 57eedb6
fix(build): fix broken Clarinet links in Build README navigation
Dark-Brain07 58ef849
docs(stacks.js): add network API endpoints table and rate limit warning
Dark-Brain07 1207396
docs: enhance main README with contribution guidelines and quick links
Dark-Brain07 fa292cf
fix: address PR review feedback - update network convention, remove m…
Dark-Brain07 f18db2a
fix: address PR review - remove invalid anchors, Next Steps section, …
Dark-Brain07 93cbc3e
fix: address review feedback - expand dot prefix explanation, link be…
Dark-Brain07 d886acb
Merge branch 'master' into docs/comprehensive-improvements
Dark-Brain07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -137,5 +137,19 @@ $ (contract-call? .counter count-up) | |
| $ (contract-call? .counter get-count tx-sender) | ||
| u2 | ||
| ``` | ||
|
|
||
| {% hint style="info" %} | ||
| **Exiting the Console**: To exit the Clarinet console, type `exit` or press `Ctrl+C`. Your contract state will be reset when you restart the console. | ||
| {% endhint %} | ||
| {% endstep %} | ||
| {% endstepper %} | ||
|
|
||
| *** | ||
|
|
||
| ## Common Beginner Mistakes | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think this would be well suited for a blog post, would you be able to link this to an external blog post that covers this information? |
||
|
|
||
| {% hint style="info" %} | ||
| For a deeper dive into common pitfalls and how to avoid them, check out this blog post: [5 Common Clarity Development Mistakes and How to Fix Them](https://dev.to/rajuice/5-common-clarity-development-mistakes-and-how-to-fix-them-3dl). | ||
| {% endhint %} | ||
|
|
||
| **A quick note on the `.` prefix**: In the Clarinet console, the `.` before a contract name (e.g., `.counter`) is shorthand for the fully qualified contract identifier. When you deploy contracts locally, they are deployed under your default deployer address. Writing `.counter` tells Clarity to look for the `counter` contract deployed by the current transaction sender. Without the `.` prefix, Clarity cannot resolve which contract you are referencing, and the call will fail with an `UnknownContract` error. This is one of the most common mistakes new Clarity developers encounter. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please check if this url is valid