Documenation Improvements and Updates #279
Conversation
tyler-romero
requested review from
brandon-wada,
honeytung,
paulina-positronix,
robotrapta and
timmarkhuff
|
Preview of the changes / reorganization |
There was a problem hiding this comment.
Yes and-
#280
Github won't let me recommend changes on lines that aren't near direct changes that you've made
Overall looks great and is a much needed improvement. I'd check with Jared before committing to dark mode, it's affecting the color scheme quite a bit.
.github/workflows/cicd.yaml
Outdated
| #"3.6", # Default on Ubuntu18.04 but openapi-generator fails | ||
| # "3.7", # Removed support as of 0.17 | ||
| # "3.8", # Removed support as of 0.19 | ||
| # "3.9", # Removed support as of 0.19 |
There was a problem hiding this comment.
Wait, this should be 3.8. We still support 3.9
There was a problem hiding this comment.
Ah my bad! replace error
| // image is expected to be a "social card". Logo for now. | ||
| image: "img/gl-icon400.png", | ||
| colorMode: { | ||
| defaultMode: 'dark', |
There was a problem hiding this comment.
While I'm also a fan of dark mode, the landing page /python-sdk/ looks bad with dark mode on. The backgrounds on the images no longer blend in and I think the blue changes away from our normal Groundlight blue
There was a problem hiding this comment.
Yeah this was maybe a bit premature - we're actually moving to a custom (dark) landing page in this PR: #278
Couple nits I noticed while reviewing from parts of the doc that weren't touched by the original set of changes in tyler/more-code-samples
|
Thanks brandon! merged your changes into this branch |
|
There are lots of line changes for sure, but the reason there are tens of thousands is due to the node package updates in package-lock.json |
paulina-positronix
left a comment
paulina-positronix
left a comment
There was a problem hiding this comment.
LGTM thank you, this is great work! I have some suggestions primarily around the order of ask_ method and labeling ask_ml as advanced.
| @@ -1,15 +1,15 @@ | |||
| # A Quick Example: Live Stream Alert | |||
There was a problem hiding this comment.
Should this be removed or replaced by your new way of processing streams described in Low-Code Stream Processor?
Co-authored-by: Paulina Varshavskaya <88207457+paulina-positronix@users.noreply.github.com>
How to Review:
This is a large documentation PR with lots of changes to formatting, wording, and site organization. In order to effectively review, please check out this branch (
tyler/more-code-samples) and runmake develop-docs-comprehensiveto see a development version of the site.Changes (selected)
ask_mlandask_confidentframegraband tuning of motion detectionAlerts, update documentation for theedge-endpointandgroundlight/stream