-
Notifications
You must be signed in to change notification settings - Fork 304
Update local-setup.md and security-intro.md #412
Conversation
This commit updates the "How to Approach the Program Security Module" lesson with the following changes: Updated Links: The outdated links to the Anchor and Native Rust development courses have been replaced with the correct URLs pointing to their respective locations in the Solana Foundation's GitHub repository. Updated the Anchor course link to Anchor. Updated the Native Rust course link to Rust native. Content Refinement: Minor edits to improve readability and clarity of the lesson text. These updates ensure that the lesson is aligned with the current documentation structure and provides accurate resources for learners.
This commit enhances the "Local Program Development" documentation with several improvements: Updated Content: Improved readability and clarity in the instructions for setting up a local development environment for Solana programs. Code Block Formatting: Properly formatted the code blocks, ensuring that each code snippet is clearly distinguished and accurately presented for users to follow. Link Verification: Verified and ensured that all external links, including those for downloading Rust, Solana CLI tools, and Anchor, are up to date and direct users to the correct resources. These changes are aimed at providing a smoother experience for users following the guide, reducing potential setup errors, and improving the overall quality of the documentation.
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.
Some changes needed. Note there are multiple other PRs for local-setup
so competition is fierce!
@@ -67,12 +53,11 @@ avm install latest | |||
avm use latest | |||
``` | |||
|
|||
Afterwards, `anchor -V` should show `anchor-cli 0.30.0`. | |||
After installation, running `anchor -V` should show `anchor-cli 0.30.0`. |
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.
This isn't the current version of Anchor.
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.
Yes, I'm currently prioritizing updates with lower complexity. Thank you for the feedback—I have already implemented the necessary changes
##### Warning: `unused variable: 'ctx'` | ||
|
||
This simply means the `initialize` instruction handler isn't doing anything yet. | ||
You can open `programs/favorites/src/lib.rs` and change `ctx` to `_ctx` or just | ||
This simply means the `initialize` instruction handler isn't doing anything yet. You can open `programs/favorites/src/lib.rs` and change `ctx` to `_ctx` or just | ||
go onto the next step. | ||
|
||
##### `No license field in package.json` warning | ||
##### Warning: `No license field in package.json` | ||
|
||
Open package.json, add `"license": "MIT"` or `"license": "UNLICENSED"` depending | ||
on preferences |
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.
You can remove these, they're fixed in Anchor 0.30.1.
"Learn how to think intelligently about security for your onchain programs, | ||
whether developing in Anchor or in Native Rust." | ||
- Understand how to approach the Program Security Module | ||
description: > |
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.
What does the >
do?
This pull request has been automatically marked as stale because it has not had recent activity. Remove stale label or comment or this will be closed in 7 days. |
Update security-intro.md
Problem
The original lesson contained outdated links to the Anchor and Native Rust development courses, which could lead to confusion or difficulty accessing the correct resources. Additionally, there were opportunities to improve the readability and clarity of the lesson text.
Summary of Changes
Fixes #
Update local-setup.md
Problem
The original local-setup.md had a formatting issue where the code for a link was exposed, showing HTML-like syntax instead of rendering as a clickable link. This could confuse users trying to access the feedback form and missed opportunities to improve the instructional clarity of the setup process.
Summary of Changes
Corrected the exposed link formatting at the end of the document so that it now properly renders as a clickable link, directing users to the feedback form for the lesson.
Fixes #