Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: update Readme.md #283

Merged
merged 1 commit into from
Feb 13, 2024
Merged

docs: update Readme.md #283

merged 1 commit into from
Feb 13, 2024

Conversation

yuxizama
Copy link
Collaborator

@yuxizama yuxizama commented Feb 6, 2024

  • Reorganized existing content to follow the new structure
  • Aligned all the header links and badges
  • Added a table of contents
  • Added a call-to-action for users to star the repo
  • Checked all links and replaced outdated ones.
  • Unified the formatting
  • Updated the support banner
  • Improved the overall content quality
  • Added missing content where necessary
  • Added more “resources” for each product
  • Ensured wording is consistent throughout

@cla-bot cla-bot bot added the cla-signed label Feb 6, 2024
@yuxizama yuxizama requested a review from aquint-zama February 8, 2024 09:06
aquint-zama
aquint-zama approved these changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@aquint-zama aquint-zama left a comment

Choose a reason for hiding this comment

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

2 minor suggestion that you could feel free to ignore, otherwise looks good to me!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
yuxizama
yuxizama commented Feb 8, 2024
View reviewed changes
Copy link
Collaborator Author

@yuxizama yuxizama left a comment

Choose a reason for hiding this comment

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

Hey!
Here are some questions left before finalizing the Readme pages.
Thanks!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
aquint-zama
aquint-zama reviewed Feb 8, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
aquint-zama
aquint-zama reviewed Feb 8, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@aquint-zama aquint-zama self-requested a review February 8, 2024 09:24
aquint-zama
aquint-zama requested changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@aquint-zama aquint-zama left a comment

Choose a reason for hiding this comment

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

some CML refs to update

@yuxizama yuxizama requested a review from aquint-zama February 9, 2024 14:57
@yuxizama
Copy link
Collaborator Author

yuxizama commented Feb 9, 2024

I've made some last few commits.
May you check the change? @aquint-zama
If all good we can merge this PR.
Thanks!

@yuxizama yuxizama merged commit 9cee5f0 into main Feb 13, 2024
4 checks passed
@yuxizama yuxizama deleted the readme-restructure branch February 13, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aquint-zama aquint-zama aquint-zama approved these changes

@immortal-tofu immortal-tofu Awaiting requested review from immortal-tofu

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@yuxizama @aquint-zama