Добавлено начальное описание возможностей библиотеки

[theshadowco]

Описание

Связанные задачи

Closes

Чеклист

Общие

• Ветка PR обновлена из develop
• Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
• Изменения покрыты тестами
• Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Дополнительно

Summary by CodeRabbit

• Documentation
  • Added detailed feature overview in the Russian documentation section.
  • Updated system requirements to reflect the new development version (Java 17) and compatibility testing up to Java 20.

[coderabbitai]

Walkthrough

The documentation for a library has been enhanced with a detailed overview of its features, which is now accessible from the main index page. Additionally, the system requirements have been updated to reflect the library's compatibility with Java 17, ensuring it's up-to-date with the latest Java versions, up to Java 20.

Changes

Files	Change Summary
docs/ru/features.md docs/ru/index.md	Added a detailed overview of library features and included it in the index.
docs/ru/systemRequirements.md	Updated to Java 17 for the MDClasses library and added compatibility tests for up to Java 20.

🐇✨
In the doc's garden, changes bloom,
Java's warmth in the library's room.
Features penned with care, a guide anew,
With each version's leap, our knowledge grew. 📚🌟

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 with CodeRabbit Bot (@coderabbitai)

• You can directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
  • @coderabbitai generate unit tests for this file
  • @coderabbitai modularize this function
• You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
  • @coderabbitai gather interesting statistics about this repository and render them in a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai generate unit tests for the src/utils.ts file.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7c14fad and 1f5de99.

Files selected for processing (3)

• docs/ru/features.md (1 hunks)
• docs/ru/index.md (1 hunks)
• docs/ru/systemRequirements.md (1 hunks)

Additional comments: 3

docs/ru/index.md (1)

• 9-9: The addition of the link to "Возможности" (features.md) seems appropriate and enhances the documentation by providing direct access to the library's features.

docs/ru/systemRequirements.md (1)

• 9-9: The update to the system requirements to reflect the use of Java 17 for development and compatibility with Java 20 is clear and informative.

docs/ru/features.md (1)

• 1-30: The new section on the library's capabilities is well-organized and provides a comprehensive overview of what the library offers, including supported metadata types and the structure of the package.

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud