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: fix typos #1723

Merged
merged 1 commit into from
Dec 29, 2023
Merged

docs: fix typos #1723

merged 1 commit into from
Dec 29, 2023

Conversation

shuoer86
Copy link
Contributor

No description provided.

Copy link

coderabbitai bot commented Dec 27, 2023

Walkthrough

The recent updates consist of a series of spelling and grammar corrections across various documentation and markdown files. These changes are primarily focused on improving the clarity and professionalism of the written content. No alterations have been made to the logic or functional aspects of the code or systems described. A new flag noCompile has been documented for an executable, and there's a mention of simplifying gas cost calculations and message verification processes.

Changes

File Path Change Summary
contracts/README.md Typo correction in "parameters" and added info on noCompile flag.
design/bridge/.../bridge_design.md Spelling correction in "necessary" and updates on gas cost calculation and message verification.
design/scratchpad/.../Design_escape_hatch.md Spelling corrections in "unforeseen" and "possession."
design/security/high_availability.md Spelling correction in "likelihood."
design/ux/Ten_Gateway.md Spelling correction in "across."
design/ux/user_data_incentives.md Grammar and spelling corrections; clarity on payment mechanism and node responsiveness.
docs/README.md Spelling correction in "separate."
docs/_docs/testnet/changelog.md Typo correction in "successful."
planning/testnet-kpis.md Language refinement for clarity and consistency.

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 with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file
    • @coderabbitai modularize this function
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
    • @coderabbitai gather interesting statistics about this repository and render them in a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai generate unit tests for the src/utils.ts file.

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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 520ea1e and 6743b49.
Files selected for processing (9)
  • contracts/README.md (1 hunks)
  • design/bridge/bridge_design.md (1 hunks)
  • design/scratchpad/Design_escape_hatch.md (2 hunks)
  • design/security/high_availability.md (1 hunks)
  • design/ux/Ten_Gateway.md (1 hunks)
  • design/ux/user_data_incentives.md (1 hunks)
  • docs/README.md (1 hunks)
  • docs/_docs/testnet/changelog.md (1 hunks)
  • planning/testnet-kpis.md (2 hunks)
Files skipped from review due to trivial changes (9)
  • contracts/README.md
  • design/bridge/bridge_design.md
  • design/scratchpad/Design_escape_hatch.md
  • design/security/high_availability.md
  • design/ux/Ten_Gateway.md
  • design/ux/user_data_incentives.md
  • docs/README.md
  • docs/_docs/testnet/changelog.md
  • planning/testnet-kpis.md

Copy link
Contributor

@GavT GavT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@otherview otherview left a comment

Choose a reason for hiding this comment

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

Hey @shuoer86 thanks for the PR 🙏 Looks good, will merge in 👏

@otherview otherview merged commit f159fb8 into ten-protocol:main Dec 29, 2023
3 checks passed
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.

3 participants