docs: update README to clarify translation validation features and improve formatting by konradmichalik · Pull Request #36 · move-elevator/composer-translation-validator

konradmichalik · 2025-07-15T06:59:56Z

Summary by CodeRabbit

Documentation
- Updated the README to clarify and broaden the description of the validate-translations command.
- Added links to detailed sections for translation formats and validators.
- Improved formatting and alignment in tables, standardized framework names, and visually highlighted severity labels for validators.

…prove formatting

coderabbitai · 2025-07-15T07:00:02Z

Walkthrough

The README file was updated to clarify and expand the description of the validate-translations command, standardize framework names, improve table formatting, and visually distinguish validator severities using colored labels. Hyperlinks were added for translation formats and validators, and the order and alignment of table entries were adjusted.

Changes

File(s)	Change Summary
README.md	Updated command description, standardized framework names, improved table formatting, added links, reordered validators, and introduced colored severity labels. No code or logic changes.

Possibly related PRs

feat: add Duplicates and Mismatch validators; enhance validation command options #3: Introduced Duplicates and Mismatch validators and enhanced the validation command and its documentation, directly related to README updates about validators.
feat: add DuplicateValuesValidator to check for duplicate values in translation files #15: Added a new DuplicateValuesValidator and updated documentation, which aligns with README changes referencing validators.

Poem

🐇
In README fields I hop and play,
With colors bright and tables neat,
I tidy rows and links today,
So docs and guides are clear and sweet.
Validators line up in style—
This bunny tweaks with flair and smile!

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (3)

README.md (3)
13-14: Singularize “translations mismatches”

Minor grammar nit ‒ “translations mismatches” should be “translation mismatches”.
-Provides a command `validate-translations` to check for translations mismatches, duplicates, schema validation and more.
+Provides a command `validate-translations` to check for translation mismatches, duplicates, schema validation, and more.
70-73: Tautology & wording polish in “Supports yaml language files”

Both “YAML” and “JSON” already imply “language”, so the extra word is redundant. While you’re here, you could also align the descriptions for consistency (they currently vary in brevity).
-| [YAML](https://en.wikipedia.org/wiki/YAML)   | Supports yaml language files.                     | [Symfony](https://symfony.com/)          | `messages.en.yaml`, `messages.de.yaml` |
-| [JSON](https://en.wikipedia.org/wiki/JSON)   | Supports JSON language files with nested key support.                     | [Laravel](https://laravel.com/) / [Symfony](https://symfony.com/)         | `messages.en.json`, `messages.de.json` |
+| [YAML](https://en.wikipedia.org/wiki/YAML)   | Supports YAML translation files.                  | [Symfony](https://symfony.com/)          | `messages.en.yaml`, `messages.de.yaml` |
+| [JSON](https://en.wikipedia.org/wiki/JSON)   | Supports JSON translation files (nested keys supported). | [Laravel](https://laravel.com/) / [Symfony](https://symfony.com/) | `messages.en.json`, `messages.de.json` |
81-90: Inline <span style="color:#…"> won’t render on GitHub

GitHub strips most inline styles for security reasons; the coloured severity labels will fall back to plain text.
Consider alternatives:

Use emoji: 🚨 / ⚠️

Use Shields.io badges.

Keep plain text but rely on column order to convey severity.

If colour is important, option 2 provides the clearest visual cue while staying GitHub-safe.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 207849f and 6765c20.

📒 Files selected for processing (1)

README.md (3 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~70-~70: This phrase is redundant (‘L’ stands for ‘language’). Use simply “yaml”.
Context: ...n.wikipedia.org/wiki/YAML) | Supports yaml language files. | [Symfony](...

(ACRONYM_TAUTOLOGY)

🔇 Additional comments (1)

README.md (1)

19-21: Nice touch adding deep-links

Linking to the dedicated sections improves discoverability and saves readers extra scrolling.

docs: update README to clarify translation validation features and im…

6765c20

…prove formatting

coderabbitai bot reviewed Jul 15, 2025

View reviewed changes

konradmichalik merged commit 97a205a into main Jul 15, 2025
28 checks passed

coderabbitai bot mentioned this pull request Jul 28, 2025

docs: improve documentation #51

Merged

konradmichalik deleted the readme-adjustments branch July 28, 2025 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update README to clarify translation validation features and improve formatting#36

docs: update README to clarify translation validation features and improve formatting#36
konradmichalik merged 1 commit intomainfrom
readme-adjustments

konradmichalik commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

konradmichalik commented Jul 15, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

konradmichalik commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)