search

celestiaorg / docs

Celestia Documentation Site
https://docs.celestia.org
170 stars 364 forks source link

docs: slim down community, fix instances of mainnet -> mainnet beta #1712

Closed jcstein closed 2 months ago

jcstein commented 2 months ago

Overview

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve significant updates to community-related documentation, primarily focusing on enhancing access to the Discord community. The modifications include replacing outdated links, removing certain community resources, and updating terminology for clarity regarding validator environments. These adjustments aim to streamline user engagement and improve the overall documentation structure.

Changes

File Change Summary
.vitepress/config.ts Updated Discord links in social media icons, navigation menu, and sidebar.
README.md Corrected capitalization in "Fork & Clone" to "Fork & clone."
community/calendar.md Removed the entire file detailing community call events.
community/foundation-delegation-program.md Updated terminology from "mainnet" to "Mainnet Beta" for clarity on validator environments.
community/itn-tos.md Removed the document outlining terms for the Incentivized Testnet Award Program.
community/overview.md Removed the "Community overview" section providing resource links.
developers/blobstream-proof-queries.md Minor textual adjustments for clarity regarding RPC endpoints.
developers/blobstream-x-requesting-data-commitment-ranges.md Updated reference link for TENDERMINT_RPC_URL to point to integrations section.
developers/node-tutorial.md Updated guidance on finding RPC endpoints for Mainnet Beta, Mocha testnet, and Arabica devnet.
developers/transaction-resubmission.md Changed "Mainnet" references to "Mainnet Beta" for clarity.
index.md Modified the "Community" feature to link directly to Discord instead of the overview page.
nodes/celestia-app-vesting.md Updated RPC endpoint references and added advisory note for production applications.
nodes/celestia-node-troubleshooting.md Clarified network naming conventions, changing "Mainnet" to "Mainnet Beta."
nodes/docker-images.md Updated RPC endpoint configuration references to integrations sections.
nodes/full-storage-node.md Updated RPC endpoint references to specific sections for Mainnet Beta, Mocha testnet, and Arabica devnet.
nodes/hardfork-process.md Changed "mainnet" to "Mainnet Beta" in testing phase descriptions.
nodes/light-node.md Updated wording for clarity on network names for RPC endpoint connections.
nodes/mainnet.md Simplified description of Mainnet Beta in documentation.
nodes/participate.md Adjusted terminology to specify "Mainnet Beta" instead of "mainnet."
nodes/validator-node.md Updated instructions for initializing a node with flexible RPC endpoint options.

Possibly related PRs

Suggested labels

documentation, enhancement, unreleased-node

Poem

🐇 In the garden where rabbits play,
Discord links brighten the way.
Community calls, now easy to find,
With every hop, we leave doubts behind.
Join us, dear friends, in this joyful spree,
Together we thrive, in harmony! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 generate interesting stats about this repository and render them as a table.` -- `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 2 months ago

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1712/ on branch main at 2024-09-16 14:11 UTC