LearnCard icon indicating copy to clipboard operation
LearnCard copied to clipboard

[LC-355] - Update LearnCard core readme

Open gerardopar opened this issue 1 year ago โ€ข 3 comments

Overview

๐ŸŽŸ Relevant Jira Issues

๐Ÿ“š What is the context and goal of this PR?

Updates the .readme, to surface using LearnCloud for storing, retrieving, & publishing credentials in place of Ceramic || IDX.

Note: Additional changes to the LearnCard docs on GitBook have been submitted for review.

๐Ÿฅด TL; RL:

๐Ÿ’ก Feature Breakdown (screenshots & videos encouraged!)

๐Ÿ›  Important tradeoffs made:

๐Ÿ” Types of Changes

  • [X] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [X] Chore (refactor, documentation update, etc)

๐Ÿ’ณ Does This Create Any New Technical Debt? ( If yes, please describe and add JIRA TODOs )

  • [X] No
  • [ ] Yes

Testing

๐Ÿ”ฌ How Can Someone QA This?

๐Ÿ“ฑ ๐Ÿ–ฅ Which devices would you like help testing on?

๐Ÿงช Code Coverage

Documentation

๐Ÿ“œ Gitbook

๐Ÿ“Š Storybook

โœ… PR Checklist

  • [X] Related to a Jira issue (create one if not)
  • [X] My code follows style guidelines (eslint / prettier)
  • [X] I have manually tested common end-2-end cases
  • [X] I have reviewed my code
  • [X] I have commented my code, particularly where ambiguous
  • [ ] New and existing unit tests pass locally with my changes
  • [X] I have made corresponding changes to gitbook documentation

๐Ÿš€ Ready to squash-and-merge?:

  • [X] Code is backwards compatible
  • [X] There is not a "Do Not Merge" label on this PR
  • [X] I have thoughtfully considered the security implications of this change.
  • [X] This change does not expose new public facing endpoints that do not have authentication

gerardopar avatar Oct 02 '24 22:10 gerardopar

๐Ÿฆ‹ Changeset detected

Latest commit: 08fe1e06b896e3ce6b40410bd5f85879438e0468

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 31 packages
Name Type
@learncard/core Patch
@learncard/snap-chapi-example Patch
@learncard/snap-example-dapp Patch
@learncard/cli Patch
@learncard/init Patch
@learncard/ceramic-plugin Patch
@learncard/chapi-plugin Patch
@learncard/crypto-plugin Patch
@learncard/did-web-plugin Patch
@learncard/didkey-plugin Patch
@learncard/didkit-plugin Patch
@learncard/dynamic-loader-plugin Patch
@learncard/ethereum-plugin Patch
@learncard/expiration-plugin Patch
@learncard/idx-plugin Patch
@learncard/network-plugin Patch
@learncard/learn-card-plugin Patch
@learncard/learn-cloud-plugin Patch
@learncard/vc-api-plugin Patch
@learncard/vc-templates-plugin Patch
@learncard/vc-plugin Patch
@learncard/vpqr-plugin Patch
@learncard/meta-mask-snap Patch
@learncard/network-brain-service Patch
@learncard/learn-cloud-service Patch
@learncard/chapi-example Patch
@learncard/create-http-bridge Patch
@learncard/react Patch
learn-card-discord-bot Patch
@learncard/network-brain-client Patch
@learncard/learn-cloud-client Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Oct 02 '24 22:10 changeset-bot[bot]

Deploy Preview for learn-card-chapi-example canceled.

Name Link
Latest commit 08fe1e06b896e3ce6b40410bd5f85879438e0468
Latest deploy log https://app.netlify.com/sites/learn-card-chapi-example/deploys/66feefddc64ce00008d96ada

netlify[bot] avatar Oct 02 '24 22:10 netlify[bot]

Deploy Preview for learncarddocs canceled.

Name Link
Latest commit 08fe1e06b896e3ce6b40410bd5f85879438e0468
Latest deploy log https://app.netlify.com/sites/learncarddocs/deploys/66feefdd8e073d000806cb46

netlify[bot] avatar Oct 02 '24 22:10 netlify[bot]