Skip to content
This repository has been archived by the owner on Jan 24, 2025. It is now read-only.

Update local-setup.md and security-intro.md #412

Closed
wants to merge 3 commits into from

Conversation

donnie-near
Copy link

@donnie-near donnie-near commented Sep 2, 2024

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

  • Updated Links:
  1. Replaced the outdated links with correct URLs that direct to the current locations of the Anchor and Native Rust development courses in the Solana Foundation's GitHub repository.
  2. The Anchor course link now points to Anchor.
  3. The Native Rust course link now points to Rust native.
  • Content Refinement:
  1. Made minor edits to improve the readability and clarity of the lesson text.
  2. These updates ensure the lesson aligns with the current documentation structure and provides accurate, up-to-date resources for learners.

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

  • Updated Links:

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.

  • Content Refinement:
  1. Edited the text for better readability, ensuring instructions are clear and easy to follow.
  2. Added explanations and steps to guide users through potential issues during the setup process.
  3. Added code block syntax highlighting for better visual differentiation of commands and code snippets.

Fixes #

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.
@donnie-near donnie-near changed the title Update security-intro.md Update local-setup.md and security-intro.md Sep 3, 2024
Copy link
Contributor

@mikemaccana mikemaccana left a 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`.
Copy link
Contributor

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.

Copy link
Author

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

Comment on lines 79 to 87
##### 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
Copy link
Contributor

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: >
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the > do?

Copy link

github-actions bot commented Dec 1, 2024

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants