Skip to content
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

Improve build section #1336

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

Ileolami
Copy link

@Ileolami Ileolami commented Mar 5, 2025

Under the build section, I worked on the introduction page and writing smart contract section(overview and setup page).
These are what I did:

  1. I improved some sentences for more clarity
  2. Added list where needed
  3. Make use of admonition for tips, warnings and info
  4. Ensure that Introduction TOC is open for easy navigation

Ileolami added 2 commits March 5, 2025 13:40
I worked on the Introduction page, Write Smart contract overview page and setup page.
@Ileolami Ileolami closed this Mar 7, 2025
@Ileolami Ileolami reopened this Mar 18, 2025
@ElliotFriend
Copy link
Contributor

Hi there, @Ileolami!

Thanks for submitting the PR! Making things more readable and better structured is always so appreciated!

I'll review the changes and get back with you. Thanks again!


:::tip

While defining rules and logic of the contract, developers must be security conscious to avoid vulnerabilities such as reentrancy attacks, integer overflows, access control flaws, and other exploits that could compromise the integrity and functionality of the smart contract.
Copy link
Contributor

Choose a reason for hiding this comment

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

Soroban doesn't allow reentrancy attacks. So it is probably a good idea to not even mention it. @ElliotFriend for confirmation this is correct.


## Install the Stellar CLI

The [Stellar CLI](https://github.com/stellar/stellar-cli) can execute smart contracts on futurenet, testnet, mainnet, as well as in a local sandbox.

:::info

The latest stable release is [v{latestVersion}](https://github.com/stellar/stellar-cli/releases/latest).
Copy link
Contributor

Choose a reason for hiding this comment

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

This is showing as v0.0.0 for me when it should be (at the time of writing) 22.6.0. Maybe it's just a preview error?

v{latestVersion}

Copy link
Author

Choose a reason for hiding this comment

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

I will fixed that


**Need help finding what you're looking for?​**
## Soroban FAQs
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with these being drop-downs but some of the tables have "Details" as a heading.
image

Copy link
Author

Choose a reason for hiding this comment

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

This problem is coming from the formatting.

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

Successfully merging this pull request may close these issues.

None yet

3 participants