improve documentation, notebooks, and async usage guidance #48
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
This also: - enable MyST-NB for rendering and executing Markdown and Jupyter notebooks - configure notebook execution settings for docs builds - add workflow guides to documentation navigation and index - link workflow guides from getting started and usage guides
This: - add missing `vessel_ids` in `docs/source/getting-started.md` - add jupyter notebooks to black dependency i.e `black[jupyter]` - add make tasks for formatting and linting notebooks
This: - document async-first behavior in getting-started guide - add tips for running async code in interactive environments - link usage guides and notebooks to official GFW API documentation pages
…aveats This: - replace generic data caveats with AIS apparent fishing effort data caveats - replace generic data caveats with AIS vessel presence data caveats - replace generic data caveats with SAR vessel detections data caveats
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.
This:
vessel_idsexample indocs/source/getting-started.mdblack[jupyter]as a dependencygfw-api-python-client