Repository navigation
Update navigation docs for 0.1.0-alpha.1 - #14
Merged
Merged
Conversation
Replace the hand-written API page with the reference generated from rnmapbox/navigation@v0.1.0-alpha.1 by TypeDoc, refresh the pages for alpha.1, and add RNNavigationView and Troubleshooting pages.
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
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.
Replaces the hand-written
docs/navigation/api.mdwith the TypeDoc reference from rnmapbox/navigation#11, generated forv0.1.0-alpha.1, underdocs/navigation/api/. After that PR, the navigation repo regenerates this folder on each release.Also refreshes the hand-written pages for alpha.1 (npm
nexttag, Expo config plugin,addArriveListener, current limitations), adds a "Choose an approach" section to the overview, and adds RNNavigationView and Troubleshooting pages. Features only on navigationmain(#10) are marked "next release".The alpha.1 tag predates the TypeDoc setup, so the reference was generated from the tag with #11's TypeDoc config and JSDoc applied, minus anything describing #10, and without source line links.