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.

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

Update README.md #284

Closed
wants to merge 2 commits into from
Closed

Update README.md #284

wants to merge 2 commits into from

Conversation

costa2400
Copy link
Contributor

enhancements have been made to the documentation of the Sylvia Framework, focusing on clarity and comprehensibility. The primary changes include the simplification of technical jargon, restructuring of complex explanations, and the addition of detailed commentary around code examples.

@costa2400 costa2400 marked this pull request as draft January 15, 2024 18:45
Copy link

codecov bot commented Jan 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (511d88b) 86.56% compared to head (7cac859) 81.15%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #284      +/-   ##
==========================================
- Coverage   86.56%   81.15%   -5.41%     
==========================================
  Files          25       25              
  Lines        1742     1725      -17     
==========================================
- Hits         1508     1400     -108     
- Misses        234      325      +91     

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

Copy link
Collaborator

@jawoznia jawoznia left a comment

Choose a reason for hiding this comment

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

One nitpick, otherwise LGTM

Also Sylvia uses conventional commits. To pass the CI you have to prefix commits like docs: Your commit message.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@kulikthebird
Copy link
Contributor

We need to update the latest version of README, there should be a new PR created for that

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.

3 participants