Documentation: update headers and structure

[c0ffeeca7]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The modifications in the documentation.md file involve a structural reorganization to enhance clarity and usability. New sections were added to support the creation of documentation pages, linking techniques, and image referencing. Existing sections were renamed for better clarity, and additional guidelines on linking within Markdown files were provided.

Changes

Files	Change Summary
source/docs/contribute/documentation.md	Reorganized sections, added guidelines for page creation, linking in Markdown, and image referencing. Renamed and updated existing sections for better clarity.

Sequence Diagram(s)

No sequence diagrams are required as the changes primarily involve documentation reorganization and clarification.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 94adc1e and a1db161.

Files selected for processing (1)

• source/docs/contribute/documentation.md (4 hunks)

Additional context used

Markdownlint

source/docs/contribute/documentation.md

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

---

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

---

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

---

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

---

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

---

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

---

16-16: null (MD034, no-bare-urls)
Bare URL used

Additional comments not posted (6)

source/docs/contribute/documentation.md (6)

43-43: Update the section header to ensure consistency with the new structure.

---

57-62: Excellent addition for guiding users on creating new pages. Please ensure the instructions are clear and concise.

---

64-69: Header format is correct and well-documented.

---

71-76: This section provides valuable instructions for linking within the documentation. Consider adding examples for clarity.

Tools

Markdownlint

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

---

91-93: Ensure external links are correctly formatted and accessible.

---

89-89: Remove trailing space to adhere to Markdown best practices as previously suggested.

- To link to an external page, use the full URL. 
+ To link to an external page, use the full URL.

Likely invalid or redundant comment.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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: 1

Outside diff range comments (3)

source/docs/contribute/documentation.md (3)

Line range hint 7-7: Remove the multiple consecutive blank lines to comply with Markdown best practices.

- 

Also applies to: 24-24

---

Line range hint 81-81: Ensure that fenced code blocks are surrounded by blank lines to adhere to Markdown formatting rules.

+ 
```yaml
title: A title for the page, this will also be used in the sidebar. For example, Feature.
description: "A summary of the contents of this page"

Also applies to: 100-100

---

Line range hint `16-16`: Convert the bare URL to a Markdown link to improve the readability and consistency of the documentation.

```diff
- The documentation site for HACS is using [Markdown](https://daringfireball.net/projects/markdown/) and is 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 is using [Markdown](https://daringfireball.net/projects/markdown/) and is built with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/). The site is hosted on [Cloudflare Pages](<https://pages.cloudflare.com/>).

[coderabbitai]

Actionable comments posted: 0

Outside diff range comments (3)

source/docs/contribute/documentation.md (3)

Line range hint 7-7: Please remove extra blank lines to adhere to Markdown conventions.

- 
+ 

Also applies to: 24-24, 73-73

---

Line range hint 82-82: Ensure that fenced code blocks are surrounded by blank lines for proper formatting.

+ 

Also applies to: 101-101

---

Line range hint 16-16: Avoid using bare URLs. Wrap them in a Markdown link format for better readability.

- https://github.com/hacs/documentation
+ [HACS Documentation Repository](https://github.com/hacs/documentation)