Document search tips, cleanup documentation

[blessedbiped]

What type of PR is this?

• documentation

What this PR does / why we need it:

No section in how-to document for search by ID syntax

Which issue(s) this PR fixes:

#135

Summary by CodeRabbit

• Documentation
  • Improved clarity and consistency in the homebox project documentation by removing redundant phrases and correcting grammatical structures.
  • Added a new instruction on searching for an Asset ID in the Homebox system, enhancing user experience and functionality of the search feature.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the documentation for the Homebox project, focusing on clarity and usability. Minor textual adjustments were made, including grammatical corrections and improved phrasing. Additionally, new instructions were introduced to assist users in efficiently searching for Asset IDs, thereby refining the overall user experience without modifying the underlying functionality.

Changes

File Path	Change Summary
docs/en/contribute/get-started.md	Minor textual adjustments for clarity, including grammatical corrections and enhanced phrasing.
docs/en/tips-tricks.md	Added instruction for searching Asset IDs using # followed by the ID, improving usability.

Poem

In the realm of Homebox, changes were made,
Clarity shines where confusion once laid.
A search for an Asset, now simple and bright,
Improvements in text make our guidance just right.
With each little tweak, our users will cheer,
For clear, concise docs bring knowledge near! 🎉

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 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

Outside diff range, codebase verification and nitpick comments (2)

docs/en/contribute/get-started.md (2)

54-54: Sir, a grammatical enhancement is in order.

The phrase "per language basis" should be hyphenated to "per-language basis" to form an adjective.

- The Sidebar must be updated on a per language basis
+ The Sidebar must be updated on a per-language basis

Tools

LanguageTool

[grammar] ~54-~54: In this context, “per-language” forms an adjective and is spelled with a hyphen.
Context: ...tc.) - The Sidebar must be updated on a per language basis - Each language's files can be na...

(PER_USER_BASIS_HYPHEN)

---

62-62: Sir, a minor punctuation adjustment is recommended.

A comma should be added after "pull request" for improved readability.

- To create a pull request you can use the following steps:
+ To create a pull request, you can use the following steps:

Tools

LanguageTool

[typographical] ~62-~62: It seems that a comma is missing.
Context: ...from a feature branch. To create a pull request you can use the following steps: 1. Fo...

(IN_ORDER_TO_VB_COMMA)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1386499 and 08ddff5.

Files selected for processing (2)

• docs/en/contribute/get-started.md (1 hunks)
• docs/en/tips-tricks.md (1 hunks)

Additional context used

LanguageTool

docs/en/contribute/get-started.md

[grammar] ~54-~54: In this context, “per-language” forms an adjective and is spelled with a hyphen.
Context: ...tc.) - The Sidebar must be updated on a per language basis - Each language's files can be na...

(PER_USER_BASIS_HYPHEN)

---

[typographical] ~62-~62: It seems that a comma is missing.
Context: ...from a feature branch. To create a pull request you can use the following steps: 1. Fo...

(IN_ORDER_TO_VB_COMMA)

Additional comments not posted (1)

docs/en/tips-tricks.md (1)

24-24: Excellent addition, sir.

The new instruction on how to search for an Asset ID is clear and enhances the usability of the search feature.