Updated documentation and dependency updates

[solid-illiaaihistov]

Summary by CodeRabbit

• New Features
  • README-based documentation generation now auto-inserts the package’s stable version.
  • Documentation generation can use a custom package configuration file.
  • Updated default web documentation output path.
• Documentation
  • Refreshed “Usage” and “Configuration” examples to use the latest lint plugin format.
  • Improved the example analysis configuration, including corrected wording and YAML formatting.
• Chores
  • Bumped a few dependency and dev-dependency versions.

[gemini-code-assist]

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

[solid-danylosafonov]

lgtm

[illia-romanenko]

@CodeRabbit review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 44f18e2c-4916-4fbd-a95b-32ce33830acb

📥 Commits

Reviewing files that changed from the base of the PR and between 868c95d and 5955387.

📒 Files selected for processing (2)

• example/analysis_options.yaml
• tool/generate_web_docs_content.dart

🚧 Files skipped from review as they are similar to previous changes (2)

• example/analysis_options.yaml
• tool/generate_web_docs_content.dart

---

📝 Walkthrough

Walkthrough

The PR updates solid_lints configuration examples, adds pubspec-based version substitution to Docusaurus documentation generation, introduces a configurable pubspec CLI path, centralizes default paths, and updates dependency versions.

Changes

Web documentation generation

Layer / File(s)	Summary
Plugin configuration examples README.md, example/analysis_options.yaml	Usage and configuration examples now place solid_lints under plugins, with version placeholders and the example’s local plugin path.
Version-aware Docusaurus formatter lib/src/utils/docs_parser/output_formatters/docusaurus_formatter.dart, pubspec.yaml	DocusaurusFormatter reads and parses a pubspec version, replaces the README version placeholder, and writes generated documentation; dependency versions are updated.
CLI path and formatter wiring tool/generate_web_docs_content.dart	Default paths are derived from projectRoot, a --pubspec option is added, and its value is passed to DocusaurusFormatter.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant DocsCLI
  participant DocusaurusFormatter
  participant pubspec.yaml
  participant README.md
  DocsCLI->>DocusaurusFormatter: construct with pubspecPath
  DocusaurusFormatter->>pubspec.yaml: read and parse version
  DocusaurusFormatter->>README.md: read documentation content
  DocusaurusFormatter->>DocusaurusFormatter: replace latest-version placeholder
  DocusaurusFormatter-->>DocsCLI: write generated intro.md and rule markdown

Loading

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the README/docs and dependency updates in this PR, though it omits the related code changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@example/analysis_options.yaml`:
- Around line 21-28: In the avoid_using_api diagnostic configuration for
Future.wait, correct the reason text by changing “looses type safety” to “loses
type safety,” without altering any other settings.

In `@tool/generate_web_docs_content.dart`:
- Around line 9-18: Update the projectRoot initialization in
generate_web_docs_content.dart to derive the repository root from the script’s
location via Platform.script instead of Directory.current.parent. Preserve the
existing README.md, pubspec.yaml, and Docusaurus path construction while
ensuring the paths resolve correctly regardless of the current working
directory.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4e16fef3-afe7-4abc-afc9-053e0f76293b

📥 Commits

Reviewing files that changed from the base of the PR and between a6d4ae1 and 868c95d.

📒 Files selected for processing (5)

• README.md
• example/analysis_options.yaml
• lib/src/utils/docs_parser/output_formatters/docusaurus_formatter.dart
• pubspec.yaml
• tool/generate_web_docs_content.dart