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

Arie comments #343

Merged
merged 3 commits into from
Jan 27, 2025
Merged

Arie comments #343

merged 3 commits into from
Jan 27, 2025

Conversation

yoav-el-certora
Copy link
Contributor

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

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.

docs/solana/options.md Show resolved Hide resolved
docs/solana/options.md Show resolved Hide resolved
docs/solana/options.md Outdated Show resolved Hide resolved
```

## Most Frequently Used Options

(--solana_inlining)=
Copy link

Choose a reason for hiding this comment

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

Did you try to compile the documentation with this?
I don't think it looks as expected

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is what we've done in the solidity docs

docs/solana/options.md Outdated Show resolved Hide resolved
docs/solana/options.md Show resolved Hide resolved
docs/solana/options.md Outdated Show resolved Hide resolved
docs/solana/options.md Outdated Show resolved Hide resolved
docs/solana/options.md Outdated Show resolved Hide resolved
docs/solana/options.md Outdated Show resolved Hide resolved
@yoav-el-certora
Copy link
Contributor Author

I think that this is missing: #335 (comment). I did not check, but are the following addressed?

Spell checking is failing as well.

Addressed comments which are relevant. Some fixes you already did in the main branch after merging the original PR.

@phreppo phreppo merged commit 5c6456b into solana/docs_template Jan 27, 2025
2 checks passed
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.

2 participants