Skip to content

docs: improve the README.md and summary in the documentation website #1087

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 1 commit into from
May 21, 2025

Conversation

behnazh-w
Copy link
Member

Summary

This PR improves the clarity and content of the README.md and the summary section of the documentation website for Macaron.

Description of changes

  • Refined and shortened the project summary in README.md for better readability
  • Emphasized key features such as attestation support, reproducible builds, and malicious artifact detection
  • Added references to tutorials and relevant blog posts

@behnazh-w behnazh-w requested a review from tromai as a code owner May 20, 2025 05:36
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label May 20, 2025
@behnazh-w behnazh-w requested a review from benmss May 20, 2025 05:36
@behnazh-w behnazh-w force-pushed the behnazh/improve-readme branch from 6857593 to 3bdcce8 Compare May 20, 2025 05:41
@behnazh-w behnazh-w force-pushed the behnazh/improve-readme branch from 3bdcce8 to 357d053 Compare May 20, 2025 05:46
Copy link
Member

@benmss benmss 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 to me.

@behnazh-w behnazh-w merged commit dcc4af3 into main May 21, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants