docs: add introductory documentation for all crates #57
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.