docs: update README with an example #133
Merged
Conversation
This file contains hidden or 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
|
Hello :) |
vmccarty
reviewed
Jun 25, 2022
TICKET: BG-50225 fix: format files Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Eric Crosson <67922293+ericcrosson-bitgo@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Eric Crosson <67922293+ericcrosson-bitgo@users.noreply.github.com> Update packages/io-ts-http/README.md Co-authored-by: Vivian McCarty <107434158+vmccarty@users.noreply.github.com>
andrew-scott-fischer
force-pushed
the
BG-50225-mention-api-spec-on-the-io-ts-http-readme
branch
from
9a2a745 to
a0beacf
Compare
Comment on lines
+213
to
+214
| The first import is the `io-ts` package. It's usually imported `as t` for use in | ||
| describing the types of data properties. Again, review | ||
| [io-ts](https://github.com/gcanti/io-ts) documentation for more context on how to use it | ||
| and this package. |
There was a problem hiding this comment.
I waffle on whether or not we can consider this assumed knowledge of our audience. I suppose we'd best not consider it base knowledge.
Where did we first reference the io-ts readme? (Referencing the word Again,)
Suggested change
| The first import is the `io-ts` package. It's usually imported `as t` for use in | |
| describing the types of data properties. Again, review | |
| [io-ts](https://github.com/gcanti/io-ts) documentation for more context on how to use it | |
| and this package. | |
| The first import is the `io-ts` package, which provides the foundation for arbitrary-precision in defining api-ts specifications. Review | |
| [the io-ts documentation](https://github.com/gcanti/io-ts/blob/master/index.md) to learn more. |
There was a problem hiding this comment.
The Preface mentions io-ts and provides a link to the docs for it.
andrew-scott-fischer
force-pushed
the
BG-50225-mention-api-spec-on-the-io-ts-http-readme
branch
from
828709f to
bcff264
Compare
docs: make intro more clear Co-authored-by: Eric Crosson <67922293+ericcrosson-bitgo@users.noreply.github.com> docs: describe more clearly what io-ts-http is used for Co-authored-by: Eric Crosson <67922293+ericcrosson-bitgo@users.noreply.github.com>
andrew-scott-fischer
force-pushed
the
BG-50225-mention-api-spec-on-the-io-ts-http-readme
branch
from
bcff264 to
5ef623d
Compare
bitgopatmcl
approved these changes
Jun 30, 2022
|
🎉 This PR is included in version 1.0.0-beta.15 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 0.2.0-beta.7 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 0.2.0-beta.4 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 0.2.0-beta.10 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
This PR landed! 🥳 🎉 Well done @andrew-scott-fischer and team! This is a major step forward, thanks for all the effort behind this milestone 🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Add an example of using
io-ts-httpTICKET: BG-50225