-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Contributing to docs: style tweaks #472
Conversation
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 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. WalkthroughThe updates to Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Instructions how to create references in markdown. | ||
|
||
### Referencing another page | ||
|
||
Lets say you need to reference another page that is located under: | ||
Let's say you need to reference another page that is located under: | ||
|
||
```text | ||
source/docs/contribute/features.md | ||
``` | ||
Then you need to use: | ||
This is a link pointing to the same website. In this case, use a relative link: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure to capitalize "Markdown" when referring to the language for consistency and correctness.
- Instructions how to create references in markdown.
+ Instructions on how to create references in Markdown.
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.
Instructions how to create references in markdown. | |
### Referencing another page | |
Lets say you need to reference another page that is located under: | |
Let's say you need to reference another page that is located under: | |
```text | |
source/docs/contribute/features.md | |
``` | |
Then you need to use: | |
This is a link pointing to the same website. In this case, use a relative link: | |
Instructions on how to create references in Markdown. | |
### Referencing another page | |
Let's say you need to reference another page that is located under: | |
```text | |
source/docs/contribute/features.md | |
``` | |
This is a link pointing to the same website. In this case, use a relative link: |
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
67-67: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Co-authored-by: Joakim Sørensen <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
@@ -2,52 +2,52 @@ | |||
title: Documentation | |||
description: "Documentation development" | |||
--- | |||
The documentation site for HACS is build with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) and hosted on [Cloudflare Pages](https://pages.cloudflare.com/) | |||
The documentation site for HACS is using [markdown](https://daringfireball.net/projects/markdown/) and built with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/). The site is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description should reflect the use of Markdown alongside mkdocs-material
.
- The documentation site for HACS is using [markdown](https://daringfireball.net/projects/markdown/) and built with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
+ The documentation site for HACS uses [Markdown](https://daringfireball.net/projects/markdown/) alongside [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
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.
The documentation site for HACS is using [markdown](https://daringfireball.net/projects/markdown/) and built with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/). The site is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). | |
The documentation site for HACS uses [Markdown](https://daringfireball.net/projects/markdown/) alongside [mkdocs-material](https://squidfunk.github.io/mkdocs-material/). The site is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). |
|
||
```yaml | ||
--- | ||
title: A Title for the page, this will also be used in the sidebar, ie. Feature | ||
title: A title for the page, this will also be used in the sidebar. For example, Feature. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enhance metadata instructions with examples for better clarity.
- description: "A nice description here"
+ description: "Provide a brief description of the page's content, such as 'Overview of Feature X.'"
Committable suggestion was skipped due to low confidence.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks 👍
No description provided.