Kaleido docs updates for v1 #5111
Conversation
…ly.py into kaleido-docs-updates
| Other Chromium-based browsers may also work, though Kaleido won't discover them automatically. You can set a browser to use by setting the path to search using an environment variable called `BROWSER_PATH`. For example: | ||
|
|
||
| ``` | ||
| BROWSER_PATH=/Applications/Microsoft\ Edge.app/Contents/MacOS/Microsoft\ Edge |
There was a problem hiding this comment.
this line should begin with export right? or do we not usually put export for env vars in the docs?
…ly.py into kaleido-docs-updates
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
Co-authored-by: Emily KL <[email protected]>
|
|
||
| pio.write_image(fig, "fig.png") | ||
| ~~~ | ||
| <!-- #endregion --> | ||
|
|
There was a problem hiding this comment.
Add section here (or elsewhere in the file) documenting the new pio.write_images function, recommended for exporting multiple images in a row because it is much faster than calling pio.write_image repeatedly.
Documentation for the function is here. Happy to help suggest wording if that would be helpful.
pio.write_images should also be referenced in the Kaleido v1 migration doc, because anyone calling write_images many times in a row will notice a significant performance hit unless they switch to using pio.write_images.
There was a problem hiding this comment.
Added an example and note in the migration doc
Co-authored-by: Emily KL <[email protected]>
There was a problem hiding this comment.
Should link to the Chrome setup instructions from this doc, since that's one of the major differences between Kaleido v0 and v1.
There was a problem hiding this comment.
Looks great @LiamConnors ! 🚀
The pio.write_images documentation should be added; all my other comments are just minor details.
This PR adds changes for Kaleido v1