-
Notifications
You must be signed in to change notification settings - Fork 16
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
solana installation and usage #339
base: solana/docs_template
Are you sure you want to change the base?
Conversation
Note that I've included two scripts |
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.
LGTM. The only thing is that I think that inline code in markdown uses only one backtick, while there are two in some places.
Also, there is a usage.md
file. Does that appear in the index.rst
?
Use the password to login to Certora following the link in the email. | ||
|
||
3. Next, install Python3.8.16 or newer on your machine. | ||
If you already have Python3 installed, you can check the version: ``python3 --version``. |
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.
I think that double backtick is for .rst
files, for .md
one should be good.
If you already have Python3 installed, you can check the version: ``python3 --version``. | |
If you already have Python3 installed, you can check the version: `python3 --version`. |
"programs/manifest/**/*.rs", | ||
"programs/manifest/justfile", | ||
"programs/manifest/Cargo.toml" |
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.
Are we allowed to use manifest as public example?
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.
True, let's rather add a minimal example from https://github.com/1arie1/solana-program-examples-audit/tree/certora-audit/basics/counter/
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.
manifest
is just a name. You can change it. In any case, manifest is public and also we are not including the code
# used by OSX, ignore otherwise | ||
export CPATH := env_var_or_default("CPATH", "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include") | ||
|
||
# magic llvm flags |
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.
toli
# magic llvm flags | |
# llvm flags |
{ | ||
"files": [ | ||
"solana_contract.so" | ||
], | ||
"process": "sbf", | ||
"optimistic_loop": false, | ||
"rule": "rule_solvency" |
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 does not have summaries or inlining. Is that OK?
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.
Given that summaries and inlining should be abandoned from a user perspective soon, I think it's even better if we don't add an example with it. If it's not required, that's even better.
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.
Sorry, I miss that. Currently, we need them.
Naming convention:
Before requesting review:
spelling_wordlist.txt
README.md
for information about style and markdown syntaxJira ticket: TODO
Link to generated documentation: TODO