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 the crate description for identity-credential #873

Merged
merged 22 commits into from
Jun 13, 2022

Conversation

olivereanderson
Copy link
Contributor

@olivereanderson olivereanderson commented Jun 9, 2022

Description of change

Updates the crate description for identity-credential to contain a basic description, some simple examples and links out to other relevant pages such as our wiki and project level examples.

Links to any relevant issues

Issues #133 and #869 need this PR.

Type of change

Add an x to the boxes that are relevant to your changes.

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Checked that the documentation looks OK with cargo doc --open (inside the identity-credentialdirectory) . All warnings reported are from other crates in the workspace.

Also runs locally under cargo test (which runs the examples in the README.md).

Change checklist

Add an x to the boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes

@olivereanderson olivereanderson self-assigned this Jun 9, 2022
@olivereanderson olivereanderson changed the title Started creating crate description Update the crate description for identity-credential Jun 9, 2022
@olivereanderson olivereanderson added this to the v0.6 Features milestone Jun 10, 2022
@olivereanderson olivereanderson added the Documentation Improvements or additions to documentation. Excludes from changelog label Jun 10, 2022
@olivereanderson olivereanderson marked this pull request as ready for review June 10, 2022 13:50
identity-credential/src/credential/credential.rs Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/src/README.md Outdated Show resolved Hide resolved
identity-credential/README.md Outdated Show resolved Hide resolved
identity-credential/README.md Outdated Show resolved Hide resolved
Oliver E. Anderson and others added 11 commits June 13, 2022 09:29
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
Co-authored-by: cycraig <craig.bester@iota.org>
@olivereanderson
Copy link
Contributor Author

All comments have been addressed.

@olivereanderson olivereanderson force-pushed the docs/identity-core-crate-description branch from b2ec181 to 44c8d85 Compare June 13, 2022 15:51
@olivereanderson olivereanderson merged commit a15f615 into dev Jun 13, 2022
@olivereanderson olivereanderson deleted the docs/identity-core-crate-description branch June 13, 2022 15:59
@olivereanderson olivereanderson mentioned this pull request Jun 14, 2022
10 tasks
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. Excludes from changelog
Projects
Development

Successfully merging this pull request may close these issues.

3 participants