Skip to content

refactor: Update README.md and improved repository #926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 45 commits into from
May 28, 2023
Merged

refactor: Update README.md and improved repository #926

merged 45 commits into from
May 28, 2023

Conversation

mbfakourii
Copy link
Member

@mbfakourii mbfakourii commented May 26, 2023

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

  • Add tests
  • Add changes to documentation (guides, repository pages, code comments)

@parse-github-assistant
Copy link

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

@parse-github-assistant parse-github-assistant bot changed the title refactor: update README.md and improved repository refactor: Update README.md and improved repository May 26, 2023
@parse-github-assistant
Copy link

Thanks for opening this pull request!

@mbfakourii mbfakourii requested a review from a team May 26, 2023 09:58
@codecov
Copy link

codecov bot commented May 26, 2023

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
@@           Coverage Diff           @@
##           master     #926   +/-   ##
=======================================
  Coverage   38.51%   38.51%           
=======================================
  Files          60       60           
  Lines        3331     3331           
=======================================
  Hits         1283     1283           
  Misses       2048     2048           

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

@Nidal-Bakir
Copy link
Member

So all the docs are now on the parseplatform site?

@mbfakourii
Copy link
Member Author

So all the docs are now on the parseplatform site?

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

Nidal-Bakir
Nidal-Bakir previously approved these changes May 26, 2023
Copy link
Member

@Nidal-Bakir Nidal-Bakir left a comment

Choose a reason for hiding this comment

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

Thanks for your work.

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

The package READMEs look good now, very compact.

@mbfakourii
Copy link
Member Author

mbfakourii commented May 28, 2023

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
Copy link
Member

mtrezza commented May 28, 2023

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
Copy link
Member

mtrezza commented May 28, 2023

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

@mbfakourii
Copy link
Member Author

Done

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

Looks good, can we merge?

@mbfakourii
Copy link
Member Author

Looks good, can we merge?

Yes, I think it is ready

@mtrezza mtrezza merged commit 4e4bfab into parse-community:master May 28, 2023
@mbfakourii
Copy link
Member Author

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

@mtrezza
Copy link
Member

mtrezza commented May 28, 2023

Done

@mtrezza
Copy link
Member

mtrezza commented May 28, 2023

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.

@mbfakourii mbfakourii deleted the improve_repository_structure branch October 3, 2023 14:59
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.

Document improvement
3 participants