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

solana installation and usage #339

Open
wants to merge 1 commit into
base: solana/docs_template
Choose a base branch
from

Conversation

caballa
Copy link

@caballa caballa commented Jan 21, 2025

Naming convention:

  • PRs for features that are in design should have the "proposal" label
  • PRs for features that haven't landed yet should have the "future" label
  • PRs for upcoming releases should have the "release" label
  • PRs with new documentation for existing features should have the "existing feature" label

Before requesting review:

  • Make sure there is a ticket in the DOC board in Jira
  • Make sure CI is passing
    • Spell check failure may require adding backticks around code or updating spelling_wordlist.txt
    • See README.md for information about style and markdown syntax
    • If the CI Details link gives a 404, you need to log in to readthedocs.com
  • Add link to generated documentation here
    • you can find this by following the read the docs link from the CI check
  • Ask for help in #documentation

Jira ticket: TODO
Link to generated documentation: TODO

@caballa
Copy link
Author

caballa commented Jan 21, 2025

Note that I've included two scripts scripts/certora_build.py and scripts/justfile.

Copy link

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

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.

Suggested change
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`.

Comment on lines +18 to +20
"programs/manifest/**/*.rs",
"programs/manifest/justfile",
"programs/manifest/Cargo.toml"
Copy link

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?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Author

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

Choose a reason for hiding this comment

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

toli

Suggested change
# magic llvm flags
# llvm flags

Comment on lines +29 to +35
{
"files": [
"solana_contract.so"
],
"process": "sbf",
"optimistic_loop": false,
"rule": "rule_solvency"
Copy link

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?

Copy link
Contributor

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.

Copy link
Author

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.

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.

3 participants