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 files with errors #1100

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Conversation

Anon-im
Copy link
Contributor

@Anon-im Anon-im commented Nov 9, 2024

Description

I updated the document files that contained errors, now the text looks grammatically correct.
In security-policy.mdx; style-guide.mdx; glossary.mdx

Tests

Additional context

Metadata

@Anon-im Anon-im requested a review from a team as a code owner November 9, 2024 10:29
Copy link

netlify bot commented Nov 9, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 08664ea
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/672f39a23788650008d4ed5e
😎 Deploy Preview https://deploy-preview-1100--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Anon-im Anon-im changed the title fix: Updated Docs Files with Errors Update docs files with errors Nov 9, 2024
Copy link
Contributor

coderabbitai bot commented Nov 9, 2024

Walkthrough

This pull request includes minor textual modifications across three documentation files. Changes involve correcting grammatical errors, such as replacing "based off" with "based on" and fixing other minor phrasing issues. The overall structure and content of the documents remain unchanged, focusing solely on enhancing clarity and grammatical accuracy.

Changes

File Path Change Summary
pages/chain/security/security-policy.mdx Corrected "based the" to "based on" for grammatical accuracy.
pages/connect/contribute/style-guide.mdx Corrected "based off" to "based on" and made minor formatting adjustments, including bullet points and punctuation.
pages/connect/resources/glossary.mdx Corrected grammatical errors in definitions, enhancing clarity without altering functionality.

Possibly related issues

Possibly related PRs

Suggested reviewers

  • sbvegan
  • krofax

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 72a4abc and 08664ea.

📒 Files selected for processing (3)
  • pages/chain/security/security-policy.mdx (1 hunks)
  • pages/connect/contribute/style-guide.mdx (4 hunks)
  • pages/connect/resources/glossary.mdx (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • pages/chain/security/security-policy.mdx
  • pages/connect/resources/glossary.mdx
🧰 Additional context used
📓 Path-based instructions (1)
pages/connect/contribute/style-guide.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
🪛 LanguageTool
pages/connect/contribute/style-guide.mdx

[uncategorized] ~526-~526: Possible missing comma found.
Context: ...-wide holiday` * Slash (/) Avoid using as the slash is reserved for file names...

(AI_HYDRA_LEO_MISSING_COMMA)


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.

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.

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.

2 participants