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

docs: update README #2219

Merged
merged 4 commits into from
Oct 10, 2024
Merged

docs: update README #2219

merged 4 commits into from
Oct 10, 2024

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Oct 7, 2024

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:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Documentation
    • Updated links to the Dash Platform documentation for improved clarity and accessibility.
    • Removed outdated information regarding Dash Platform availability on the Testnet.
    • Revised the "Supported networks" section with new links to specific documentation.
    • Minor formatting adjustments made throughout the README.

Remove note about not being on mainnet
Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

Walkthrough

The changes in the pull request focus on updating the README.md file for the Dash Platform. Key modifications include the removal of the section about Dash Platform's availability on the Testnet, updates to the "Supported networks" section with new links pointing to the docs.dash.org site, and adjustments to the documentation hosting information. Minor formatting changes were also applied throughout the document to enhance clarity and accessibility.

Changes

File Change Summary
README.md Removed Testnet availability note; updated links for development networks, Testnet, and Mainnet to docs.dash.org; modified documentation hosting info from readme.io to docs.dash.org; minor formatting adjustments.

Poem

🐰 In the garden of Dash, we update with glee,
New links sprout up, as clear as can be.
The Testnet's old tale has been put to rest,
With docs that now guide us, we’ll surely be blessed!
Hoppity hop, let’s share what we’ve found,
In the world of Dash, our knowledge is sound! 🌼


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@thephez thephez marked this pull request as ready for review October 7, 2024 13:22
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 link

The 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 availability

The 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

📥 Commits

Files that changed from the base of the PR and between 1e39669 and f9b58a3.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🔇 Additional comments (1)
README.md (1)

90-90: LGTM: Documentation link successfully updated

The 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.

@QuantumExplorer QuantumExplorer merged commit 91235b1 into v1.4-dev Oct 10, 2024
19 checks passed
@QuantumExplorer QuantumExplorer deleted the thephez-patch-1 branch October 10, 2024 09:59
@thephez thephez added this to the v1.4.0 milestone Oct 30, 2024
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.

Remove "Note: Dash Platform is currently available on the Dash Testnet only" from README
2 participants