docs: improve README

[rootulp]

A few miscellaneous fixes in the README

[coderabbitai]

Walkthrough

Walkthrough

The updates to the celestia-app primarily focused on enhancing the documentation across different modules, improving clarity, updating links, and refining the software's usage instructions. These changes aim to provide better guidance for validators and users interacting with the Celestia network nodes.

Changes

File Path	Change Summary
README.md	Updated descriptions, usage instructions, and documentation references for Celestia network nodes.
pkg/proof/README.md	Corrected URLs, refined descriptions and explanations related to share commitment in transactions.

Possibly related issues

• Issue Improve docs for x/upgrade #3223: Might be related as it involves improving documentation for a specific module (x/upgrade), similar in intent to the general documentation enhancements observed in this PR.

---

Recent Review Details

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 1d73e33 and 8538a6c.

Files selected for processing (2)

• README.md (5 hunks)
• pkg/proof/README.md (6 hunks)

Additional comments not posted (5)

README.md (2)

73-79: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [40-76]

The installation instructions are clear and detailed, including security verification steps.

---

124-138: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [106-135]

The contributing guidelines and tools section is comprehensive and promotes best practices.

pkg/proof/README.md (3)

Line range hint 1-7: The introduction and prerequisites section provides necessary background information clearly and concisely.

---

8-24: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [11-32]

The detailed explanation of the PayForBlob transaction and share commitment generation is clear and enhanced by helpful diagrams.

---

60-72: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [34-88]

The inclusion proof mechanisms and square layout explanations are thorough and effectively aided by visual representations.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 1

Actionable comments outside the diff hunks (1)

README.md (1)

Line range hint 87-87: Remove extra whitespace for better readability in the table.

- | Variable        | Explanation                        | Default value                                            | Required |
+ | Variable       | Explanation                       | Default value                                           | Required |

[coderabbitai]

Capitalize the first letter of the sentence to maintain consistency and professionalism.

- celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [full consensus nodes](https://docs.celestia.org/nodes/full-consensus-node) on the Celestia consensus network.
+ Celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [full consensus nodes](https://docs.celestia.org/nodes/full-consensus-node) on the Celestia consensus network.

---

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.

Suggested change

	celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [full consensus nodes](https://docs.celestia.org/nodes/full-consensus-node) on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack:
	Celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [full consensus nodes](https://docs.celestia.org/nodes/full-consensus-node) on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack:

[cmwaters]

Nice clean up 🧹