Small documentation improvements #504
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
The main branch evolves, and the documentation should evolve with it. Link to TypeScript interfaces and code samples on the main branch to avoid confusing users with outdated information. The documentation can still go out-of-date, of course. Mitigate that a bit by avoiding to link exact line numbers within a file, since they are most likely to change.
|
Ah, I just saw I fixed the same issue as #503 (among other things). I'll rebase when the other PR goes in first. |
|
Thanks for the contribution! |
Closed
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.
While setting up the GitHub Action provided by this project I came across some minor papercuts in the documentation that confused me initially.
See the individual commit messages for details.