feat(docs): i18n support added to docs #69
Conversation
|
Warning Rate limit exceeded@katosdev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 37 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 recent changes expand and refine the documentation, particularly for English users. The Changes
Poem
Tip Early access features
Note:
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 (
|
Deploying homebox-docs with
|
| Latest commit: |
4995e04
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d7442aac.homebox-docs.pages.dev |
| Branch Preview URL: | https://docs-i18n.homebox-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- docs/.vitepress/config.mts (2 hunks)
- docs/en/contribute/bounty.md (1 hunks)
- docs/en/contribute/get-started.md (1 hunks)
- docs/en/index.md (1 hunks)
- docs/en/tips-tricks.md (1 hunks)
- docs/public/_redirects (1 hunks)
- package.json (1 hunks)
Files not reviewed due to errors (2)
- docs/en/index.md (no review received)
- docs/en/tips-tricks.md (no review received)
Files skipped from review due to trivial changes (2)
- docs/public/_redirects
- package.json
Additional context used
LanguageTool
docs/en/contribute/bounty.md
[uncategorized] ~6-~6: A comma might be missing here.
Context: ... issues. After digging through several platforms we ended up settling on https://www.bos...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~8-~8: For conciseness, consider replacing this expression with an adverb.
Context: ...k it's about the best one we could find at the moment to lower the rates as much as possible ...(AT_THE_MOMENT)
[style] ~8-~8: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1359 characters long)
Context: ... we found were as high as a combined 16%!!!) We hope that by enabling bounties on ...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~10-~10: A comma might be missing here.
Context: ...nted quicker can sponsor issues, and in turn everyone contributing code can potentia...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ontributor wanting to accept money from bounties you simply need to register for an acco...(AI_HYDRA_LEO_MISSING_COMMA)
docs/en/contribute/get-started.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ... that when installing dependencies with pnpm you must use the--shamefully-hoistf...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~22-~22: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...dependencies with pnpm you must use the--shamefully-hoistflag. If you don't use this flag, you ...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[uncategorized] ~27-~27: You might be missing the article “the” here.
Context: ...t Notes start commandtask go:run1. API Server does not auto reload. You'll nee...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~27-~27: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...dtask go:run1. API Server does not auto reload. You'll need to restart the server afte...(AUTO_HYPHEN)
[uncategorized] ~50-~50: The official spelling of this programming framework is “Node.js”.
Context: ...cumentation contributions you only need NodeJS and PNPM. ::: info Notes - Languages a...(NODE_JS)
[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 languages files can be nam...(PER_USER_BASIS_HYPHEN)
[uncategorized] ~55-~55: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... updated on a per language basis - Each languages files can be named independently (slugs...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~62-~62: It seems that a comma is missing.
Context: ...form a feature branch. To create a pull request you can use the following steps: 1. Fo...(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~66-~66: A comma might be missing here.
Context: ... tested, add tests 3. If you've changed APIs update the documentation 4. Ensure that...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/en/index.md
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...equires minimal resources to deploy. In general idle memory usage is less than 50MB for...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ... so many robust features and management options which makes it easy to become overwhelm...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~51-~51: To elevate your writing, try using a synonym here.
Context: ...y when you have a lot of data, and it's hard to keep track of what's where. I also w...(HARD_TO)
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust way than a spreadsheet can provide. I also wanted to leave the door open for ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~55-~55: Possible missing comma found.
Context: ...tems and managing them is a key goal of Homebox which means you lose out on some of the...(AI_HYDRA_LEO_MISSING_COMMA)
docs/en/tips-tricks.md
[uncategorized] ~26-~26: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...approaches to manage Asset IDs: ### 1. Auto Incrementing IDs This is the default behavior likel...(AUTO_HYPHEN)
[uncategorized] ~30-~30: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... is recommended for most users. ### 2. Auto Incrementing IDs with Reset In some cases, you may ...(AUTO_HYPHEN)
[style] ~56-~56: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...his allows you to send notifications to a variety of services. On your profile page, you can...(A_VARIETY_OF)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ..., you can add notification URLs to your profile which will be used to send notification...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
docs/en/contribute/bounty.md
3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
12-12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
15-15: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
6-6: null
Bare URL used(MD034, no-bare-urls)
19-19: null
Bare URL used(MD034, no-bare-urls)
19-19: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/en/contribute/get-started.md
70-70: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
48-48: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
60-60: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
53-53: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
docs/en/index.md
44-44: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/en/tips-tricks.md
62-62: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
58-58: Expected: underscore; Actual: asterisk
Strong style(MD050, strong-style)
58-58: Expected: underscore; Actual: asterisk
Strong style(MD050, strong-style)
69-69: Expected: underscore; Actual: asterisk
Strong style(MD050, strong-style)
69-69: Expected: underscore; Actual: asterisk
Strong style(MD050, strong-style)
Additional comments not posted (2)
docs/.vitepress/config.mts (2)
12-17: Locale configuration added successfully.The locale configuration for English has been correctly added. This is a crucial part of supporting multiple languages on the site.
34-57: Sidebar configuration for internationalization.The sidebar configuration has been updated to include sections for English content and contributing. This aligns with the project's goal of supporting multiple languages.
Adds i18n support to the documentation so that those that speak other languages can start adding their own preferred languages.
Summary by CodeRabbit
New Features
Improvements
/en/quick-start).Chores
package.jsonto specify the package manager and version (pnpm@9.1.4).