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

Update docs #2118

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Update docs #2118

merged 1 commit into from
Jul 31, 2024

Conversation

ebuchman
Copy link
Member

@ebuchman ebuchman commented Jul 31, 2024

Make the landing page more excitingly about PSS and clarify that PSS will be permisionless imminently

Summary by CodeRabbit

  • New Features

    • Enhanced documentation for Partial Set Security (PSS) and Interchain Security, clarifying governance processes and the role of the Cosmos Hub.
    • Introduced promotional content emphasizing the Cosmos Hub as the best platform for launching chains.
    • Expanded explanations on Opt-In chains, highlighting future permissionless launches.
  • Bug Fixes

    • Improved clarity and detail in security framework descriptions to aid user understanding.

@ebuchman ebuchman requested a review from a team as a code owner July 31, 2024 17:22
Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Walkthrough

Walkthrough

The documentation for Partial Set Security (PSS) and Interchain Security has been revised to enhance clarity and detail. Key updates include a clearer distinction between PSS and the previous Replicated Security model, improved descriptions of governance processes, and the introduction of new features that facilitate permissionless chain launches. These changes aim to better inform users about security dynamics and governance implications within the Cosmos Hub ecosystem.

Changes

Files Change Summary
docs/docs/features/partial-set-security.md Revised introduction contrasting PSS with Replicated Security; refined top_N parameter details; expanded Opt-In chains section to emphasize flexibility and future permissionless launches. Clarified governance proposal requirements.
docs/docs/index.mdx Updated title to "Cosmos Hub - Interchain Security"; added promotional content positioning the Cosmos Hub as a leading platform; referenced the launch of PSS for context on validator engagement.

Possibly related issues


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>.
    • 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 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.
    • @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 as 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.

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

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.

@github-actions github-actions bot added the C:Docs Assigned automatically by the PR labeler label Jul 31, 2024
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: 1

For Opt In chains, this is a temporary measure to prevent issues around chain ID squatting, i.e. someone could spuriously register many desirable chain IDs of upcoming consumer chain and simply deny legitimate consumer chains from using them. Eventually, the plan is to allow launching Opt In chains permissionlessly without going through governance, with quality control being handled by the market of validators deciding which chains they would like to validate on.
As a temporary measure, Opt In chains also require a governance proposal, but this will be removed in the next release, making Opt In chains completely permissionless.

The reason Opt In chains currently require a governance prop is to prevent issues around chain ID squatting, i.e. someone could spuriously register many desirable chain IDs of upcoming consumer chain and simply deny legitimate consumer chains from using them. The plan is to allow launching Opt In chains permissionlessly without going through governance, with quality control being handled by the market of validators deciding which chains they would like to validate on.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing Article

Consider adding "an" before "upcoming consumer chain" for grammatical correctness.

- desirable chain IDs of upcoming consumer chain
+ desirable chain IDs of an upcoming consumer chain
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.

Suggested change
The reason Opt In chains currently require a governance prop is to prevent issues around chain ID squatting, i.e. someone could spuriously register many desirable chain IDs of upcoming consumer chain and simply deny legitimate consumer chains from using them. The plan is to allow launching Opt In chains permissionlessly without going through governance, with quality control being handled by the market of validators deciding which chains they would like to validate on.
The reason Opt In chains currently require a governance prop is to prevent issues around chain ID squatting, i.e. someone could spuriously register many desirable chain IDs of an upcoming consumer chain and simply deny legitimate consumer chains from using them. The plan is to allow launching Opt In chains permissionlessly without going through governance, with quality control being handled by the market of validators deciding which chains they would like to validate on.
Tools
LanguageTool

[uncategorized] ~28-~28: Possible missing article found.
Context: ...ly register many desirable chain IDs of upcoming consumer chain and simply deny legitima...

(AI_HYDRA_LEO_MISSING_AN)

@mpoke mpoke enabled auto-merge July 31, 2024 17:32
Copy link
Contributor

@jtremback jtremback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mpoke mpoke added this pull request to the merge queue Jul 31, 2024
Merged via the queue into main with commit 38826fa Jul 31, 2024
11 of 14 checks passed
@mpoke mpoke deleted the bucky/docs branch July 31, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Docs Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants