Skip to content

Conversation

@Zfinix
Copy link
Contributor

@Zfinix Zfinix commented Oct 22, 2025

Description

This PR clean up minor issues in the documentation, like:

  • Enforcing sentence case on all titles
  • Refactoring "Shelf vs Relic" to be "Migration from Shelf"
  • Adding pub.dev API Reference link

Related Issues

Link any related issues here. If this PR fixes an issue, use the following syntax to close it automatically:

  • ?

Pre-Launch Checklist

Please ensure that your PR meets the following requirements before submitting:

  • This update focuses on a single feature or bug fix. (For multiple fixes, please submit separate PRs.)
  • I have read and followed the Dart Style Guide and formatted the code using dart format.
  • I have referenced at least one issue this PR fixes or is related to.
  • I have updated/added relevant documentation (doc comments with ///), ensuring consistency with existing project documentation.
  • I have added new tests to verify the changes.
  • All existing and new tests pass successfully.
  • I have documented any breaking changes below.

Breaking Changes

  • Includes breaking changes.
  • No breaking changes.

Additional Notes

@Zfinix Zfinix self-assigned this Oct 22, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 22, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/polish-docs

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.23%. Comparing base (143f85d) to head (197d9ff).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #236   +/-   ##
=======================================
  Coverage   91.23%   91.23%           
=======================================
  Files          88       88           
  Lines        3343     3343           
  Branches     1720     1720           
=======================================
  Hits         3050     3050           
  Misses        293      293           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Zfinix Zfinix changed the title chore: clean up docs, enforced sentence case and refactored relic-shelf docs chore: Clean up docs, enforced sentence case and refactored relic-shelf docs Oct 22, 2025
@Zfinix Zfinix changed the title chore: Clean up docs, enforced sentence case and refactored relic-shelf docs docs: Clean up docs, enforced sentence case and refactored relic-shelf docs Oct 22, 2025
Copy link
Contributor

@vlidholt vlidholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments that would be good to have fixed. It would be good to get a review on the code from @nielsenko

@Zfinix Zfinix requested review from vlidholt October 24, 2025 05:43
Copy link
Collaborator

@nielsenko nielsenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is come code regarding ContextProperty that won't compile.

Also, could't help myself but comment a bit on style. You can disregard that, if you disagree (or you know others do).

@Zfinix Zfinix requested a review from nielsenko October 24, 2025 12:12
Copy link
Collaborator

@nielsenko nielsenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples are correct.

@Zfinix Zfinix force-pushed the chore/polish-docs branch from 1988683 to 952bf15 Compare October 27, 2025 09:09
@Zfinix Zfinix enabled auto-merge (squash) October 27, 2025 09:44
Copy link
Contributor

@vlidholt vlidholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor changes.

@Zfinix Zfinix merged commit e99bf0c into main Oct 27, 2025
26 of 27 checks passed
@Zfinix Zfinix deleted the chore/polish-docs branch October 27, 2025 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants