Skip to content

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

nathan-contino
Copy link
Member

No description provided.

Copy link

netlify bot commented May 27, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 547d940
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6836228abb29680008635a29
😎 Deploy Preview https://deploy-preview-4341--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🔴 down 11 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label May 27, 2025
@nathan-contino nathan-contino force-pushed the data-ai-discoverability branch from 2ac7188 to dc2cd66 Compare May 27, 2025 15:48
@viambot
Copy link
Member

viambot commented May 27, 2025

It looks like the following files may have been renamed. Please ensure you set all needed aliases:
rename docs/data-ai/ai/{advanced => }/upload-external-data.md (99%) rename docs/data-ai/data/{advanced => }/alert-data.md (98%) rename docs/data-ai/{ai/run-inference.md => inference/_index.md} (98%) rename docs/data-ai/{ai => inference}/act.md (98%) rename docs/data-ai/{ai => inference}/alert.md (98%) rename docs/data-ai/{capture-data/capture-other-sources.md => inference/augment-visual-inference-with-sensor-data.md} (14%) rename docs/data-ai/{reference/architecture.md => inference/output-tabular-data-from-inference.md} (17%) rename docs/data-ai/{capture-data/advanced => reference}/advanced-data-capture-sync.md (96%) rename docs/data-ai/{ai/advanced => reference/api}/_index.md (50%) rename docs/data-ai/reference/{ => api}/data-client.md (80%) rename docs/data-ai/reference/{ => api}/data-management-client.md (73%) rename docs/data-ai/reference/{ => api}/ml-model-client.md (74%) rename docs/data-ai/reference/{ => api}/ml-training-client.md (78%) rename docs/data-ai/reference/{ => api}/vision-client.md (77%)

Copy link
Collaborator

@npentrel npentrel left a 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
---
Copy link
Collaborator

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."
Copy link
Collaborator

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 @@
---
Copy link
Collaborator

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.

Comment on lines +7 to +8
aliases:
- /data-ai/reference/data-client/
Copy link
Collaborator

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"
Copy link
Collaborator

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"
Copy link
Collaborator

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
Copy link
Collaborator

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 @@
---
Copy link
Collaborator

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?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants