-
Notifications
You must be signed in to change notification settings - Fork 48
Create Quickstart section and reduce restructuring to the minimum needed to fit new content #4341
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Create Quickstart section and reduce restructuring to the minimum needed to fit new content #4341
Conversation
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
2ac7188
to
dc2cd66
Compare
… in preview, update next pages for quickstart pages
It looks like the following files may have been renamed. Please ensure you set all needed aliases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall love this direction, a few small pieces of feedback. I recognize you may not use this PR for actually implementing it but added here for context anyway
type: "docs" | ||
open_on_desktop: true | ||
header_only: true | ||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make this an empty parent, unless the plage itself communcates something of value that isn't just "there's three steps in these subpages"
weight: 20 | ||
layout: "docs" | ||
type: "docs" | ||
description: "Capture images on your machine to use for inference." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is that needed for a quickstart even? Would it not be better to use inference on live images? Then you cut out one additional step? You don't show data capture then - is that vital?
@@ -0,0 +1,11 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To also save space in the left nav and limit duplication, I'd move this to a "requirements" section and then link to our existing pages that cover setup.
aliases: | ||
- /data-ai/reference/data-client/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because this is not a real page but only something used for forwarding you can skip these aliases. It's very unlikely we'll get 404s from those.
@@ -1,5 +1,5 @@ | |||
--- | |||
title: "Conditional cloud sync" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice
@@ -1,5 +1,5 @@ | |||
--- | |||
linkTitle: "Filter data" | |||
linkTitle: "Filter captured data" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discuss with Jack probably but I wonder if Selective sync would get better across that the filtering is happening before sync. Maybe Filter before sync is also an option
type: "docs" | ||
empty_node: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we do actually want to keep these top level pages empty. There's been a lot of confusion on whether people get confused with some of these having content and others not having content. I think in this case (1) we have a child page with almost the same name so the content should be merged onto that page or this page's content needs to go into reference. (2) with the current design the top level pages really don't feel like they should have content themselves. No other top level page currently does. (3) this isn't the first thing you'd want to tell someone. This is the info for people who want to know more so it should come after they get the basics.
@@ -0,0 +1,10 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Run inference section is now very long compared to other sections. Consider grouping them (Maybe Detecting & Tracking, Augmenting, Autonomous decisions?)
No description provided.