Skip to content
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

DOCS-2644: Address Alyssa's feedback #3144

Merged
merged 7 commits into from
Jul 19, 2024
Merged

Conversation

npentrel
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 18, 2024
Copy link
Collaborator

@JessamyT JessamyT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Main thing is to fix the duplicated first step in part 2 and corresponding step numbers after

docs/use-cases/image-data.md Outdated Show resolved Hide resolved
@@ -69,18 +70,37 @@ For example, set it to `0.05` to capture an image every 20 seconds.

Set the MIME type to your desired image format, for example `image/jpeg`.

**Click save to start capturing data.**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this bold?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's quite far down in the step, so worried people will miss it/forget

{{% /tablestep %}}
{{% tablestep %}}
{{<imgproc src="/services/ml/collect.svg" class="fill alignleft" style="max-width: 150px" declaredimensions=true alt="Train models">}}
**4. View data in the Viam app**

{{< alert title="Wait until data appears" color="note" >}}
Your data will sync at the specified sync interval, which may mean you have to wait for data to appear.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Your data will sync at the specified sync interval, which may mean you have to wait for data to appear.
Your data will sync at the specified sync interval, which may mean you have to wait and then refresh the page for data to appear.

docs/use-cases/image-data.md Outdated Show resolved Hide resolved
docs/use-cases/image-data.md Outdated Show resolved Hide resolved
docs/use-cases/image-data.md Outdated Show resolved Hide resolved
Your data will sync at the specified sync interval, which may mean you have to wait for data to appear.

If no data appears after the sync interval, check the [**Logs**](/cloud/machines/#logs) and ensure that the condition for filtering is met.
You can add a [`transform` camera](/components/camera/transform/) to see detections or classifications live from the [**CONTROL** tab](/cloud/machines/#control).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems slightly unrelated to this alert. Consider moving/removing or at least adding a new line to make a separate paragraph.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed the alert around it

@npentrel npentrel requested a review from JessamyT July 19, 2024 15:37
Comment on lines 118 to 121
{{% /tablestep %}}
{{% tablestep link="/services/vision/"%}}
{{<imgproc src="/services/ml/train.svg" class="fill alignleft" style="max-width: 150px" declaredimensions=true alt="Train models">}}
**2. Add an ML model to your machine**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{% /tablestep %}}
{{% tablestep link="/services/vision/"%}}
{{<imgproc src="/services/ml/train.svg" class="fill alignleft" style="max-width: 150px" declaredimensions=true alt="Train models">}}
**2. Add an ML model to your machine**

This is duplicated, and then step numbers need changing.

@npentrel npentrel requested a review from JessamyT July 19, 2024 15:52
@viambot
Copy link
Member

viambot commented Jul 19, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3144

@npentrel npentrel merged commit fbb7a3c into viamrobotics:main Jul 19, 2024
8 checks passed
@npentrel npentrel deleted the DOCS-2644 branch July 19, 2024 16:01
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