Add doc improvements #2
Conversation
WalkthroughThe recent changes consist of minor textual and grammatical updates across various documentation files. These modifications enhance clarity, improve readability, and ensure stylistic consistency without altering any underlying functionality or logic. Additionally, some comments in the configuration files were refined for better guidance. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (6)
docs/Overview/additional-features.md (1)
14-14: Consider reducing wordiness.The phrase "a variety of" may be wordy. Consider simplifying it to "various" for clarity.
- Running software to validate a variety of AVS protocols + Running software to validate various AVS protocolsTools
LanguageTool
[style] ~14-~14: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...operation Running software to validate a variety of AVS protocols is a task that is best le...(A_VARIETY_OF)
first-principles.md (1)
19-20: Consider varying sentence beginnings.Three successive sentences begin with "We." Consider rephrasing for stylistic variation.
- We are not first-time builders in crypto. We also did not get into crypto for the hype. We were in this space when no one knew what it was. + As experienced builders in crypto, we did not get into it for the hype. Our involvement dates back to when no one knew what it was.Tools
LanguageTool
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o did not get into crypto for the hype. We were in this space when no one knew wha...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~20-~20: This expression is usually spelled with a hyphen.
Context: ...ce when no one knew what it was. Product Market Fit is not a commonly used metric in cr...(PRODUCT_MARKET_HYPHEN)
developers-guides/for-builders/architecture.md (1)
7-7: Add a comma for clarity.Consider adding a comma after "lockups" to improve readability.
- Solayer assets at this layer won't have any unbinding lockups since they unwrap into the respective LSTs. + Solayer assets at this layer won't have any unbinding lockups, since they unwrap into the respective LSTs.Tools
LanguageTool
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... at this layer won't have any unbinding lockups since they unwrap into the respective L...(AI_HYDRA_LEO_MISSING_COMMA)
solayer-overview/endogenous-avs/delegate-tokens.md (1)
23-23: Adjust heading level for consistency.The heading level should increment by one level at a time. Consider changing the heading level from H3 to H2.
- ### Getting an AVS Token  + ## Getting an AVS Token Tools
Markdownlint
23-23: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
solayer-overview/what-is-ssol/ssol-in-defi.md (1)
27-27: Use a heading instead of emphasis.Consider using a heading for "LP Example" instead of emphasis to improve structure and readability.
- **LP Example** + ### LP ExampleTools
Markdownlint
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
informational/how-to-use/use-ledger.md (1)
35-35: Consider Adding a Comma for Clarity.The sentence could benefit from a comma after "Therefore" to enhance readability.
- Therefore for third-party integrations, you will only be able to sign the transaction if blind signing is on. + Therefore, for third-party integrations, you will only be able to sign the transaction if blind signing is on.Tools
LanguageTool
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ions cannot be displayed on the Ledger. Therefore for third-party integrations, you will ...(AI_HYDRA_LEO_MISSING_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (27)
- .github/workflows/deploy.yml (2 hunks)
- README.md (1 hunks)
- community/restaking-epochs/README.md (1 hunks)
- community/restaking-epochs/epoch-0.md (2 hunks)
- community/restaking-epochs/epoch-1.md (1 hunks)
- community/solayer-valley-episodes/rewards-claiming-guide.md (2 hunks)
- community/solayer-valley-episodes/unstaking-credit-deduction.md (2 hunks)
- developers-guides/for-builders/architecture.md (1 hunks)
- developers-guides/security/multisig-committee.md (1 hunks)
- docs/Overview/additional-features.md (1 hunks)
- docs/Overview/basics.md (1 hunks)
- docs/intro.md (1 hunks)
- docusaurus.config.ts (2 hunks)
- first-principles.md (1 hunks)
- informational/brand-kit.md (1 hunks)
- informational/how-to-use/use-ledger.md (2 hunks)
- solayer-overview/endogenous-avs/delegate-tokens.md (1 hunks)
- solayer-overview/endogenous-avs/quality-of-service.md (1 hunks)
- solayer-overview/introduction/faq.md (7 hunks)
- solayer-overview/introduction/terms-and-concepts.md (1 hunks)
- solayer-overview/restaking-guides/delegation.md (1 hunks)
- solayer-overview/restaking-guides/lst-restaking/README.md (1 hunks)
- solayer-overview/restaking-guides/unstake-ssol/README.md (3 hunks)
- solayer-overview/what-is-ssol/README.md (1 hunks)
- solayer-overview/what-is-ssol/liquidity.md (1 hunks)
- solayer-overview/what-is-ssol/ssol-in-defi.md (2 hunks)
- why-on-solana.md (1 hunks)
Files skipped from review due to trivial changes (18)
- .github/workflows/deploy.yml
- README.md
- community/restaking-epochs/README.md
- community/restaking-epochs/epoch-0.md
- community/restaking-epochs/epoch-1.md
- community/solayer-valley-episodes/rewards-claiming-guide.md
- community/solayer-valley-episodes/unstaking-credit-deduction.md
- developers-guides/security/multisig-committee.md
- docs/intro.md
- docusaurus.config.ts
- informational/brand-kit.md
- solayer-overview/endogenous-avs/quality-of-service.md
- solayer-overview/introduction/terms-and-concepts.md
- solayer-overview/restaking-guides/delegation.md
- solayer-overview/restaking-guides/lst-restaking/README.md
- solayer-overview/restaking-guides/unstake-ssol/README.md
- solayer-overview/what-is-ssol/README.md
- solayer-overview/what-is-ssol/liquidity.md
Additional context used
LanguageTool
docs/Overview/additional-features.md
[style] ~14-~14: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...operation Running software to validate a variety of AVS protocols is a task that is best le...(A_VARIETY_OF)
first-principles.md
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o did not get into crypto for the hype. We were in this space when no one knew wha...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~20-~20: This expression is usually spelled with a hyphen.
Context: ...ce when no one knew what it was. Product Market Fit is not a commonly used metric in cr...(PRODUCT_MARKET_HYPHEN)
developers-guides/for-builders/architecture.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: ... at this layer won't have any unbinding lockups since they unwrap into the respective L...(AI_HYDRA_LEO_MISSING_COMMA)
docs/Overview/basics.md
[grammar] ~21-~21: The word “opt-in” is a noun. The verb is spelled with a white space.
Context: ...application-layer restaking system to opt-in to validate activity against additional...(NOUN_VERB_CONFUSION)
informational/how-to-use/use-ledger.md
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ions cannot be displayed on the Ledger. Therefore for third-party integrations, you will ...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~36-~36: The word “therefore” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...d" as Ledger cannot read smart contract details, therefore Ledger will automatically display as "u...(THUS_SENTENCE)
solayer-overview/introduction/faq.md
[grammar] ~68-~68: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top right corner”?
Context: ...On the dApp, click the « Restake » page on the top right corner (on the left of your wallet address) b...(ON_IN_THE_CORNER)
[uncategorized] ~80-~80: Possible missing comma found.
Context: ...ill validate transactions on the Solana network and the APY is generated from the fees ...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~107-~107: This noun is normally spelled as one word.
Context: ...hared with a multi-sig wallet. Out of 5 key holders, at least 3 confirmations are required ...(HOLDER_COMPOUNDS)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...r discretion or following a moderator’s suggestion open a support ticket (In Discord) ###...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
why-on-solana.md
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
solayer-overview/endogenous-avs/delegate-tokens.md
23-23: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
solayer-overview/what-is-ssol/ssol-in-defi.md
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (19)
docs/Overview/additional-features.md (2)
10-10: Improved readability: Corrected phrase.The phrase "delegate operation of the validator software" was improved to "delegate the operation of the validator software," enhancing clarity.
14-14: Typographical correction: Fixed typo.Corrected "service distruption" to "service disruption," addressing a typographical error.
Tools
LanguageTool
[style] ~14-~14: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...operation Running software to validate a variety of AVS protocols is a task that is best le...(A_VARIETY_OF)
first-principles.md (3)
19-19: Improved clarity: Corrected hyphenation.The term "first-time" is now correctly hyphenated, enhancing grammatical accuracy.
Tools
LanguageTool
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o did not get into crypto for the hype. We were in this space when no one knew wha...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
23-23: Improved clarity: Added article.The addition of "a" in "there were a few strategic decisions" improves grammatical accuracy.
26-26: Improved clarity: Streamlined phrasing.The term "standardized" replaces "restandardized," streamlining the phrasing without altering the meaning.
why-on-solana.md (3)
3-3: Consistent hyphenation: Corrected term.The term "proof-of-stake" is now consistently hyphenated, aligning with standard terminology.
5-5: Improved grammatical accuracy: Corrected preposition.The phrase "existing stake in such chains" improves grammatical accuracy.
9-9: Consistent hyphenation: Corrected phrase.The phrase "high-execution infrastructure" now includes a hyphen, maintaining consistency with similar terms.
docs/Overview/basics.md (3)
13-13: Improved Clarity in Sentence Structure.The changes enhance readability and grammatical correctness. No issues found.
15-15: Grammatical Improvement for Restrictive Clause.The change aligns with standard grammatical conventions, improving clarity.
19-23: Enhanced Text Flow and Precision.The modifications improve the text's flow and precision, maintaining the original meaning.
Tools
LanguageTool
[grammar] ~21-~21: The word “opt-in” is a noun. The verb is spelled with a white space.
Context: ...application-layer restaking system to opt-in to validate activity against additional...(NOUN_VERB_CONFUSION)
informational/how-to-use/use-ledger.md (3)
31-31: Improved Readability with Definite Article.The addition of the definite article enhances readability and clarity.
36-36: Improved Sentence Structure for Clarity.The changes enhance clarity and maintain the original meaning.
Tools
LanguageTool
[typographical] ~36-~36: The word “therefore” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...d" as Ledger cannot read smart contract details, therefore Ledger will automatically display as "u...(THUS_SENTENCE)
54-54: Clarified Phrase for Better Understanding.The changes improve clarity and understanding of the context.
solayer-overview/introduction/faq.md (5)
15-15: Improved Clarity and Grammatical Correctness.The changes enhance clarity and grammatical correctness, maintaining the original meaning.
30-32: Enhanced Readability and Grammatical Accuracy.The changes improve readability and grammatical accuracy without altering the original meaning.
34-34: Improved Clarity and Readability.The changes enhance clarity and readability while maintaining the original meaning.
68-68: Corrected Preposition Usage for Grammatical Accuracy.The change improves grammatical accuracy and enhances clarity.
Tools
LanguageTool
[grammar] ~68-~68: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the top right corner”?
Context: ...On the dApp, click the « Restake » page on the top right corner (on the left of your wallet address) b...(ON_IN_THE_CORNER)
80-80: Improved Sentence Structure for Clarity and Correctness.The changes enhance clarity and grammatical correctness while maintaining the original meaning.
Tools
LanguageTool
[uncategorized] ~80-~80: Possible missing comma found.
Context: ...ill validate transactions on the Solana network and the APY is generated from the fees ...(AI_HYDRA_LEO_MISSING_COMMA)
|
|
||
| The concept of shared security emerged to solve this issue - leveraging the stake in established POS systems with well-recognized assets like ETH and Solana. These systems, with their established validator networks, can provide security for other decentralized systems. Newer networks could use the existing stake on such chains to provide economic guarantees and security.  | ||
| The concept of shared security emerged to solve this issue - leveraging the stake in established POS systems with well-recognized assets like ETH and Solana. These systems, with their established validator networks, can provide security for other decentralized systems. Newer networks could use the existing stake in such chains to provide economic guarantees and security.  | ||
|
|
||
| ### Solana's Superior Infrastructure  |
There was a problem hiding this comment.
Correct heading level increment.
Heading levels should increment by one level at a time. Change the heading to ## for proper structure.
### Solana's Superior Infrastructure 
## Solana's Superior Infrastructure Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Solana's Superior Infrastructure  | |
| ## Solana's Superior Infrastructure  |
Tools
Markdownlint
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
Hello,
I have made several fixes while checking this repo.
Hope it helps.
BR,
Loredana.
Summary by CodeRabbit