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 files, update architecture diagram #719

Merged
merged 4 commits into from
Jan 9, 2023
Merged

Conversation

Patrik-Stas
Copy link
Contributor

@Patrik-Stas Patrik-Stas commented Jan 5, 2023

  • The root readme.md is more general and also
    • it puts aries-vcx along with the smaller subcrates as main components
    • libvcx is nuanced as "one of the crates built on aries-vcx"
  • Add specific readme for libvcx
  • Add specific readme for aries-vcx
  • Updated maintainers file
  • Update architecture diagrams - where originally we had 1 diagram which spanned from libcx wrappers all way down to aries-vcx modules, now there's 2 diagrams instead.
    • One diagram for aries-vcx crate architecture only
    • One diagram for libvcx and surrounding language wrappers, depicting aries-vcx simply as 1 component

Signed-off-by: Patrik Stas patrik.stas@absa.africa

@Patrik-Stas Patrik-Stas requested a review from a team as a code owner January 5, 2023 17:17
@codecov-commenter
Copy link

codecov-commenter commented Jan 5, 2023

Codecov Report

Merging #719 (c81b846) into main (9e0b170) will decrease coverage by 19.04%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main     #719       +/-   ##
===========================================
- Coverage   64.34%   45.29%   -19.05%     
===========================================
  Files         245      242        -3     
  Lines       22837    17652     -5185     
  Branches     5074     3448     -1626     
===========================================
- Hits        14694     7996     -6698     
- Misses       4017     7306     +3289     
+ Partials     4126     2350     -1776     
Flag Coverage Δ
unittests-aries-vcx 45.29% <ø> (-18.91%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...tocols/proof_presentation/prover/states/initial.rs 0.00% <0.00%> (-100.00%) ⬇️
...cols/proof_presentation/verifier/states/initial.rs 0.00% <0.00%> (-100.00%) ⬇️
aries_vcx/src/handlers/discovery/mod.rs 0.00% <0.00%> (-93.94%) ⬇️
aries_vcx/tests/utils/scenarios.rs 0.00% <0.00%> (-80.47%) ⬇️
...ies_vcx/src/core/profile/modular_wallet_profile.rs 0.00% <0.00%> (-76.48%) ⬇️
aries_vcx/src/plugins/anoncreds/indy_anoncreds.rs 2.70% <0.00%> (-75.68%) ⬇️
...vcx/src/handlers/revocation_notification/sender.rs 0.00% <0.00%> (-75.00%) ⬇️
aries_vcx/src/utils/provision.rs 0.00% <0.00%> (-73.69%) ⬇️
aries_vcx/src/common/credentials/mod.rs 0.00% <0.00%> (-73.04%) ⬇️
aries_vcx/tests/utils/devsetup_agent.rs 0.00% <0.00%> (-73.02%) ⬇️
... and 133 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

gmulhearn
gmulhearn previously approved these changes Jan 9, 2023
Copy link
Contributor

@gmulhearn gmulhearn left a comment

Choose a reason for hiding this comment

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

lgtm, just a couple comments

ROADMAP_2023.md Outdated Show resolved Hide resolved
agents/rust/aries-vcx-agent/README.md Outdated Show resolved Hide resolved
aries_vcx/README.md Show resolved Hide resolved
Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
@mirgee mirgee merged commit 8948316 into main Jan 9, 2023
@mirgee mirgee deleted the docs/updates branch January 9, 2023 15:33
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.

4 participants