chore: update docs, ci, and automation

[zhukeev]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @zhukeev, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refining the project's development workflow and documentation. It introduces automation for version synchronization, improves the pre-commit hook for consistent code formatting, and enhances the CI process with publish validation. Additionally, the user-facing documentation and internal code comments have been significantly updated to provide clearer guidance and better maintainability.

Highlights

• Pre-commit Hook Enhancements: The .githooks/pre-commit script has been updated to include a new sync_readme_version.sh script, prioritize FVM's Dart SDK for formatting, and ensure README.md changes are staged.
• Documentation Updates: The README.md has been refreshed with new examples, updated configuration tables, and a new image. Numerous dartdoc comments have been added across the public API for improved clarity.
• CI Pipeline Improvements: The Continuous Integration (CI) setup now includes a dart pub publish --dry-run step to validate package publishability, enhancing release confidence.
• Code Modernization and Deprecation: Example code in README.md has been updated to use SpoilerTextWrapper and SpoilerTextFieldWrapper, with SpoilerText now explicitly marked as deprecated.
• New Script for Version Synchronization: A new script, scripts/sync_readme_version.sh, has been added to automatically keep the package version in README.md consistent with pubspec.yaml.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/ci.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request brings a series of valuable improvements to documentation, CI, and developer automation. The updated README.md with refreshed examples and clearer configuration tables is a great enhancement for users. Adding dartdoc comments across the public API significantly improves code clarity and maintainability. The new pre-commit hook and version synchronization script are excellent additions for automating repository maintenance. I've suggested a couple of improvements to the version parsing logic in the new script to make it more robust against different semver formats. Overall, this is a solid contribution to the project's quality.