chore: fix docs #1
Conversation
hello. I found some awkward sentences and modefied it to make the grammar and wording clearer. Also added a link to the solayer, just like in the other epoch docs. Hope this helps.
Matched the date notation. Fixed wording and awkward grammar in sentences.
Removed incorrectly generated whitespace in solayer links. Refined the text.
refine restaking guide link. remove typo
Writings link is not working (https://solayer.org/blogs), Fix it correctly. (https://solayer.org/blog)
WalkthroughThe recent updates across various documents primarily focus on enhancing clarity, readability, and consistency. Minor grammatical corrections, formatting adjustments, and wording refinements have been made to improve the user experience without altering the core content. Noteworthy changes include standardizing date formats and updating terminology for better understanding. 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: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- community/restaking-epochs/epoch-0.md (1 hunks)
- community/restaking-epochs/epoch-1.md (1 hunks)
- community/restaking-epochs/epoch-2.md (1 hunks)
- informational/how-to-use/use-ledger.md (2 hunks)
- solayer-overview/introduction/official-links.md (1 hunks)
Files skipped from review due to trivial changes (2)
- community/restaking-epochs/epoch-2.md
- solayer-overview/introduction/official-links.md
Additional context used
LanguageTool
community/restaking-epochs/epoch-0.md
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: # Epoch 0 **Genesis stage (Epoch 0) of the Solayer launch i...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~5-~5: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...s of the community who have received an invite code can participate in the restaking p...(AN_INVITE)
[style] ~16-~16: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...*How to participate?** 1. Get an invite code 2. Access [app.solayer.org](...(AN_INVITE)
community/restaking-epochs/epoch-1.md
[style] ~19-~19: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...** #### How to participate: 1. Get an invite code 2. Access[app.solayer.org](http://...(AN_INVITE)
informational/how-to-use/use-ledger.md
[uncategorized] ~54-~54: Possible missing preposition found.
Context: ...-SOL in your wallet as a representation SPL. Please note that it is NOT transferrab...(AI_EN_LECTOR_MISSING_PREPOSITION)
Markdownlint
community/restaking-epochs/epoch-0.md
14-14: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
community/restaking-epochs/epoch-1.md
11-11: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
17-17: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Additional comments not posted (8)
community/restaking-epochs/epoch-0.md (3)
9-9: LGTM!The correction to "maximum cap of $20M total value locked (TVL)" enhances clarity.
10-10: LGTM!The update to "Every invitee who accesses the platform" enhances grammatical accuracy.
17-19: LGTM!The formatting of the access URL as a hyperlink and the change from "socials" to "social media" improve usability and clarity.
community/restaking-epochs/epoch-1.md (3)
5-5: LGTM!The standardization of the date format to "June 15, 2024" improves readability.
13-13: LGTM!The adjustment to "disabled after Epoch 1" clarifies the timing of the change.
20-21: LGTM!The formatting of the access URL as a hyperlink and the change from "socials" to "social media" improve usability and clarity.
informational/how-to-use/use-ledger.md (2)
54-54: LGTM!The modification to "restaking guide" enhances the specificity of the link provided.
Tools
LanguageTool
[uncategorized] ~54-~54: Possible missing preposition found.
Context: ...-SOL in your wallet as a representation SPL. Please note that it is NOT transferrab...(AI_EN_LECTOR_MISSING_PREPOSITION)
74-74: LGTM!The removal of the backslash improves the overall presentation.
| @@ -1,21 +1,21 @@ | |||
| # Epoch 0 | |||
|
|
|||
| **Genesis stage (Epoch 0) of Solayer launch is **_**private, invite-only, and time-capped.**_  | |||
| **Genesis stage (Epoch 0) of the Solayer launch is **_**private, invite-only, and time-capped.**_  | |||
There was a problem hiding this comment.
Add the missing article "the".
The phrase "the Genesis stage" would be more grammatically accurate.
- **Genesis stage (Epoch 0) of the Solayer launch is **_**private, invite-only, and time-capped.**_ 
+ **The Genesis stage (Epoch 0) of the Solayer launch is **_**private, invite-only, and time-capped.**_ 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.
| **Genesis stage (Epoch 0) of the Solayer launch is **_**private, invite-only, and time-capped.**_  | |
| **The Genesis stage (Epoch 0) of the Solayer launch is **_**private, invite-only, and time-capped.**_  |
Tools
LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: # Epoch 0 **Genesis stage (Epoch 0) of the Solayer launch i...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
|
|
||
| Unlike Epoch 0, there was no time limit imposed on Epoch 1, allowing participants ample time to engage with the restaking pool. However, native SOL deposits were prioritized to ensure the stability and growth of the platform. Withdrawals will be enabled starting at Epoch 3, providing participants with flexibility in managing their investments. | ||
|
|
||
| *** | ||
|
|
||
| #### Permanent Referral Link | ||
|
|
||
| Participants who deposited 10 native SOL received a permanent referral link, granting them a significant advantage. Through this link, they could earn 10% of their referees' rewards, enhancing their potential earnings. It’s important to note that one-time use codes are disabled post Epoch 1, making the permanent referral link an exclusive benefit. | ||
| Participants who deposited 10 native SOL received a permanent referral link, granting them a significant advantage. Through this link, they could earn 10% of their referees' rewards, enhancing their potential earnings. It’s important to note that one-time use codes were disabled after Epoch 1, making the permanent referral link an exclusive benefit. | ||
|
|
||
| *** | ||
|
|
||
| #### How to participate: |
There was a problem hiding this comment.
Remove trailing punctuation in heading.
The heading "How to participate:" should not have a trailing colon.
- #### How to participate:
+ #### How to participateCommittable 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.
| #### How to participate: | |
| #### How to participate |
Tools
Markdownlint
17-17: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Hello, I found awkward sentence formatting, typos, and broken links in the documentation. I've fixed these to make the document clearer and more complete.
Hope this helpful.
Summary by CodeRabbit