Skip to content

docs(README): update and organize readme and supplementary documentation of the repository#944

Merged
BrunoCampana merged 21 commits intomasterfrom
docs/readme-and-organization
May 21, 2024
Merged

docs(README): update and organize readme and supplementary documentation of the repository#944
BrunoCampana merged 21 commits intomasterfrom
docs/readme-and-organization

Conversation

@BrunoCampana
Copy link
Contributor

Motivation

  • README was outdated.
  • Overall documentation of this repository was outdated.
  • Documentation of codebase isn't standardized.

Acceptance Criteria

  • Update README.
  • Organize the documentation of repository.
  • Update non-default docs to standardize them.

Standards that must be followed: (all from engineering-guidelines repository)

Checklist

  • If you are requesting a merge into master, confirm this code is production-ready and can be included in future releases as soon as it gets merged

@BrunoCampana BrunoCampana added the documentation Improvements or additions to documentation label Feb 8, 2024
@BrunoCampana BrunoCampana self-assigned this Feb 8, 2024
@BrunoCampana BrunoCampana changed the title docs(README): update and organize the documentation of repository docs(README and docs dir): update and organize README and supplementary documentation of the repository Feb 8, 2024
@BrunoCampana BrunoCampana changed the title docs(README and docs dir): update and organize README and supplementary documentation of the repository docs(README): update and organize README and supplementary documentation of the repository Feb 8, 2024
@BrunoCampana BrunoCampana changed the title docs(README): update and organize README and supplementary documentation of the repository docs(README): update and organize readme and supplementary documentation of the repository Feb 8, 2024
@codecov
Copy link

codecov bot commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.91%. Comparing base (5122b9f) to head (fb4f1ba).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #944      +/-   ##
==========================================
+ Coverage   84.87%   84.91%   +0.04%     
==========================================
  Files         297      297              
  Lines       22910    22910              
  Branches     3464     3464              
==========================================
+ Hits        19444    19454      +10     
+ Misses       2779     2770       -9     
+ Partials      687      686       -1     

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

jansegre
jansegre previously approved these changes Feb 19, 2024
jansegre
jansegre previously approved these changes Feb 20, 2024
@BrunoCampana BrunoCampana requested a review from msbrogli April 22, 2024 18:49
@BrunoCampana BrunoCampana enabled auto-merge May 8, 2024 15:58
@BrunoCampana BrunoCampana requested a review from jansegre May 9, 2024 17:00
@BrunoCampana BrunoCampana merged commit 75605be into master May 21, 2024
@BrunoCampana BrunoCampana deleted the docs/readme-and-organization branch May 21, 2024 18:20
This was referenced May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants