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

docs: add introductory documentation for all crates #57

Merged
merged 7 commits into from
Sep 12, 2023

Conversation

nanderstabel
Copy link
Collaborator

@nanderstabel nanderstabel commented Sep 6, 2023

Description of change

This change adds an introductory documentation for all the crates, basically setting the context for each library by referring their respective specification documents and how the different libraries relate to one another.

The previous code example was outdated so it is completely removed in this current change. Up to date code examples will be introduced again in a future update (after some some refactoring --> #56).

Links to any relevant issues

Mentioned in #43: 'individual crates should be easy to understand for first-time users'. This PR ads more context to the different crates. In a future change there will be diagrams and code examples added to the documentation as well.

How the change has been tested

n/a

Definition of Done 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 commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@nanderstabel nanderstabel marked this pull request as ready for review September 6, 2023 16:02
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
oid4vc-core/README.md Outdated Show resolved Hide resolved
oid4vc-manager/README.md Outdated Show resolved Hide resolved
oid4vci/README.md Outdated Show resolved Hide resolved
@nanderstabel nanderstabel merged commit b743f3c into dev Sep 12, 2023
@nanderstabel nanderstabel deleted the docs/documentation branch September 12, 2023 09:12
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.

2 participants