parse-community / Parse-SDK-Flutter

The Dart/Flutter SDK for Parse Platform
https://parseplatform.org
Apache License 2.0
575 stars 186 forks source link

refactor: Update `README.md` and improved repository #926

Closed mbfakourii closed 1 year ago

mbfakourii commented 1 year ago

Pull Request

Issue

Closes: #885

Approach

Update flutter README.md Update dart README.md Update main README.md

Delete unnecessary folders Fix and add new badges Fix logo size in api reference

Tasks

parse-github-assistant[bot] commented 1 year ago

I will reformat the title to use the proper commit message syntax.

parse-github-assistant[bot] commented 1 year ago

Thanks for opening this pull request!

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (298406b) 38.51% compared to head (e9a2d6a) 38.51%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #926 +/- ## ======================================= Coverage 38.51% 38.51% ======================================= Files 60 60 Lines 3331 3331 ======================================= Hits 1283 1283 Misses 2048 2048 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

Nidal-Bakir commented 1 year ago

So all the docs are now on the parseplatform site?

mbfakourii commented 1 year ago

So all the docs are now on the parseplatform site?

yes https://docs.parseplatform.org/flutter/guide/

mbfakourii commented 1 year ago

The package READMEs look good now, very compact.

changes are applied. It has a very good structure. ๐Ÿ‘Œ๐Ÿ‘Œ

Looks like it's ready to merge.

Please re-run the documentation CI after merging to resolve the logo issue.

mtrezza commented 1 year ago
image

Could you remove the "docs passing", likes, popularity, points badges? We want to reduce badges in all READMEs and I'm not sure how meaningful they are for developers. They see these infos in the pub.dev registry anyway.

The structure should be: row 1: technical: image row 2: versions: image row 3: marketing: image

mtrezza commented 1 year ago

Could you add the Backers section before the contributors section in the README?

mbfakourii commented 1 year ago

Done

mbfakourii commented 1 year ago

Looks good, can we merge?

Yes, I think it is ready

mbfakourii commented 1 year ago

@mtrezza Please re-run the documentation CI to resolve the logo issue.

mtrezza commented 1 year ago

Done

mtrezza commented 1 year ago

There was no update, because the docs are created based on a release tag. The tags are in the past, so any changes wonโ€™t reflect there yet. The docs will be updated when the next release is published.