docs: fix typo in documentation

[defitricks]

Description

I noticed a typo in the documentation where "beggining" was used instead of the correct spelling "beginning."
I’ve fixed it to ensure accuracy.

Summary by CodeRabbit

• Documentation
  • Corrected a typographical error in the configuration description, improving the clarity and accuracy of the project documentation.

[coderabbitai]

Walkthrough

The pull request corrects a typographical error in the polygon/README.md file. The word "beggining" has been updated to "beginning" in the description of the scaling.startP2PPort key within the values table. No functional changes have been made in this update.

Changes

File	Change Summary
polygon/README.md	Corrected spelling of "beggining" to "beginning" in the scaling.startP2PPort key description.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this 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 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: 0

🧹 Nitpick comments (1)

polygon/README.md (1)

155-155: Markdown Table Formatting Suggestion.
Markdownlint indicates that table rows should have both leading and trailing pipes. In this case, line 155 is missing a leading pipe. Consider updating the line to:

-| scaling.startP2PPort | integer |  | A beginning port for the range to use in P2P NodePorts |
+| scaling.startP2PPort | integer |  | A beginning port for the range to use in P2P NodePorts |

This change will ensure consistent and standard-compliant Markdown formatting.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

155-155: Table pipe style
Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe

(MD055, table-pipe-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64e183a and fc4c11e.

📒 Files selected for processing (1)

• polygon/README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

polygon/README.md

155-155: Table pipe style
Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe

(MD055, table-pipe-style)

🔇 Additional comments (1)

polygon/README.md (1)

155-155: Typo Correction Confirmed.
The typo in the description of scaling.startP2PPort has been corrected from "beggining" to "beginning," which improves the clarity of the documentation.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

155-155: Table pipe style
Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe

(MD055, table-pipe-style)

[cjorge-graphops]

Hi @defitricks 👋 thank you for your contribution!

As that documentation is auto-generated, this change would need you to be made here:

launchpad-namespaces/src/schemas/polygon.cue

Line 46 in 0dd7173

// A beggining port for the range to use in P2P NodePorts

, and then docs get auto generated. That did not happen for you with the commit hook, when making this commit because you do not have setup the repo yet (Contributor's Guide). You will also need CUE, but there's instruction on that guide.

If you are up for it, we'd really appreciate if you could take this one forward 🙇 and let us know if we can help in any way. Either way, very appreciated bringing this to our attention! :)