docs: fix typos, grammar, and improve contributing docs#2159
Open
Dark-Brain07 wants to merge 9 commits intostx-labs:mainfrom
Open
docs: fix typos, grammar, and improve contributing docs#2159Dark-Brain07 wants to merge 9 commits intostx-labs:mainfrom
Dark-Brain07 wants to merge 9 commits intostx-labs:mainfrom
Conversation
hugo-stacks
requested changes
Feb 6, 2026
Comment on lines
+19
to
+26
| Before you start contributing, make sure you have: | ||
|
|
||
| - Rust (>=1.89.0) and Cargo installed | ||
| - Node.js (>=v24.4.1) and npm (>=11.5.2) for SDK work | ||
| - Git for version control | ||
| - A code editor (VSCode recommended for the extension support) | ||
|
|
||
| For more details, see the [README](../README.md#prerequisites). |
Collaborator
There was a problem hiding this comment.
Not sure if that's useful as it, but I like the idea of removing this old "wip".
So that we don't have to update the versions in the future, I'd recommend setting:
- Rust latest stable
- Node latest LTS
Remove git and vscode, at this point, we expect contributors to know what they are doing.
And we could move the whole README prerequisites section here
Comment on lines
+18
to
+19
| - [ ] Code builds without errors (`cargo build`) | ||
| - [ ] Code formatted with `cargo fmt-stacks` |
Collaborator
There was a problem hiding this comment.
The CI while check that, no need for additional checkboxes
|
|
||
| > To check out more installation methods, click | ||
| > [here](https://docs.hiro.so/stacks/clarinet#installation) | ||
| > [here](https://docs.hiro.so/stacks/clarinet#installation). |
Collaborator
There was a problem hiding this comment.
Docs link updated (see conflicts I guess)
Collaborator
|
Thanks @Dark-Brain07 |
Dark-Brain07
force-pushed
the
feature/docs-and-improvements
branch
from
93f120f to
08993e7
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Spotted a few things while going through the docs:
Nothing major, just some housekeeping.
Checklist