Feat/diagrams and docs #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krhoda
force-pushed
the
feat/diagrams-and-docs
branch
from
edbac3e
to
2cf17be
Compare
Deploying with
|
| Latest commit: |
cc2d34e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6e843554.rebase.pages.dev |
| Branch Preview URL: | https://feat-diagrams-and-docs.rebase.pages.dev |
krhoda
force-pushed
the
feat/diagrams-and-docs
branch
11 times, most recently
from
564bad5
to
4be6e95
Compare
obstropolos
approved these changes
Dec 8, 2022
Improves base library's README to include diagrams of the flow, explanations of the file structure, walkthroughs for each witnessed flow, supported usecases, and extension options. Changes how types are exposed in some of the downstream libs to decrease the need for peer deps. Improves the Witness SDK's README Improves the demos' READMEs Updates demo witness' secrets.md and endpoints.md to match current implementation Updates docs to use spec.rebase.xyz for context Updates deps for SSI Adds link to gitbook from rustdoc Updates grammar and formatting of readmes and explainers Updates README to act as more a sign post for the GitBook
krhoda
force-pushed
the
feat/diagrams-and-docs
branch
from
a833f1f
to
cc2d34e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Depends on #39
Improves documentation across the board, also improves how deps are handled by re-exporting exposed types, rather than requiring the calling application to use peer deps.