ts-web/core: docs additions (hosed version) #1163
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
pro-wh
added
c:docs
pro-wh
commented
Oct 12, 2022
| @@ -1,6 +1,6 @@ | |||
| # An oasis-core SDK for TypeScript | |||
|
|
|||
| Developers, see [this getting started guide](docs/getting-started.md). | |||
| Users of this package, see [this getting started guide](docs/getting-started.md). | |||
There was a problem hiding this comment.
we already had a link to a sample envoy configuration. clarifying this link to indicate that users of this package should see the guide there
pro-wh
commented
Oct 12, 2022
| ## Running in Node.js | ||
|
|
||
| This package and some of its dependencies do not support running in Node.js. | ||
| Only use this package in browsers. |
There was a problem hiding this comment.
should we downgrade this statement to "Running this in Node.js may be possible with fallback implementations of browser APIs, but we do not have guidance on configuring this"?
There was a problem hiding this comment.
Has it been tested to work? If yes, we could downgrade, otherwise just leave as-is.
There was a problem hiding this comment.
no. only that there are some unit tests we run in node
kostko
approved these changes
Oct 12, 2022
|
wait what |
|
ugh I'll have to reopen |
pro-wh
changed the title
Merged
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.
including additions suggested in #1160