-
Notifications
You must be signed in to change notification settings - Fork 39
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
docs: update README #2219
docs: update README #2219
Conversation
Remove note about not being on mainnet
WalkthroughThe changes in the pull request focus on updating the 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
README.md (2)
42-44
: LGTM with a minor suggestion for the mainnet linkThe updated links to the new documentation site (docs.dash.org) are correct and more specific. This change aligns well with the PR objectives.
However, there's a small issue with the mainnet link:
Consider updating the mainnet link as follows:
-- [x] [Mainnet](https://docs.dash.org/projects/platform/en/stable/docs/reference/glossary.html#devnet#mainnet) ++ [x] [Mainnet](https://docs.dash.org/projects/platform/en/stable/docs/reference/glossary.html#mainnet)This will ensure the link points directly to the mainnet entry in the glossary.
Line range hint
1-90
: Consider adding a brief statement about current availabilityThe removal of the note regarding Dash Platform's availability on the Testnet aligns with the PR objectives. This change implies that the platform might now be available on more networks, including mainnet.
Consider adding a brief statement about the current availability of Dash Platform across different networks. This could provide valuable context for users and developers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (2 hunks)
🧰 Additional context used
🔇 Additional comments (1)
README.md (1)
90-90
: LGTM: Documentation link successfully updatedThe change to the documentation link is correct and aligns with the PR objectives. The new link points to the appropriate introduction page on the new docs.dash.org site.
Issue being fixed or feature implemented
Remove note about not being on mainnet. Related to dashpay/platform-tui#92.
Closes #2226
What was done?
Remove note about not being on mainnet and update several links
How Has This Been Tested?
N/A
Breaking Changes
N/A
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit