Contributing to docs: style tweaks #472

c0ffeeca7 · 2024-06-17T13:30:23Z

No description provided.

coderabbitai · 2024-06-17T13:30:30Z

Warning

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 40 minutes and 21 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 97250e9 and d806848.

Walkthrough

The updates to documentation.md enhance clarity and specificity in the contribution process, refining instructions and adding new details for better contributor understanding. Significant modifications include rephrasing guidelines, specifying the usage of markdown with mkdocs-material, and detailing in-depth steps for local development and previewing contributions.

Changes

Files/Groups	Change Summary
`source/docs/contribute/documentation.md`	Enhanced clarity and specificity in contribution process instructions.
	Rephrased sections and refined guidelines for better understanding.
	Updated commands and steps for local development and live previews.

Sequence Diagram(s)

sequenceDiagram
    participant Contributor
    participant DocumentationSite
    participant GitHub
    Contributor->>+DocumentationSite: Start devcontainer
    DocumentationSite-->>Contributor: Preview website
    Contributor->>+GitHub: Edit documentation
    GitHub-->>Contributor: Submit changes
    Contributor->>+DocumentationSite: Refresh preview
    DocumentationSite-->>Contributor: Live view changes

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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 Configration 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: 3

Outside diff range comments (1)

source/docs/contribute/documentation.md (1)
Line range hint 78-82: The instructions for referencing images are clear, but ensure fenced code blocks are surrounded by blank lines for proper Markdown formatting.
+ ![image](/assets/images/features.png)
Tools

LanguageTool

[grammar] ~59-~59: Did you mean the formatting language “Markdown” (= proper noun)? (MARKDOWN_NNP)
Context: ...nstructions how to create references in markdown.

Referencing another page

Let...

Markdownlint

73-73: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces

56-56: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

67-67: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines