Skip to content

Commit 057664e

Browse files
authored
Merge pull request #1013 from roboflow/docs-feedback
Action Docs Feedback
2 parents 9e73887 + b63f753 commit 057664e

File tree

6 files changed

+92
-47
lines changed

6 files changed

+92
-47
lines changed

README.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
[![downloads](https://img.shields.io/pypi/dm/inference)](https://pypistats.org/packages/inference)
1919
[![docker pulls](https://img.shields.io/docker/pulls/roboflow/roboflow-inference-server-cpu)](https://hub.docker.com/u/roboflow)
2020
[![license](https://img.shields.io/pypi/l/inference)](https://github.com/roboflow/inference/blob/main/LICENSE.core)
21-
[![discord](https://img.shields.io/discord/1159501506232451173?logo=discord&label=discord&labelColor=fff&color=5865f2&link=https%3A%2F%2Fdiscord.gg%2FGbfgXGJ8Bk)](https://discord.gg/GbfgXGJ8Bk)
2221

2322
<!-- [![huggingface](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Roboflow/workflows) -->
2423

@@ -86,42 +85,61 @@ Workflows allow you to extend simple model predictions to build computer vision
8685
<tr>
8786
<!-- Left cell (thumbnail) -->
8887
<td width="300" valign="top">
89-
<a href="https://youtu.be/tZa-QgFn7jg">
90-
<img src="https://img.youtube.com/vi/tZa-QgFn7jg/0.jpg"
91-
alt="Smart Parking with AI" width="300" />
88+
<a href="https://youtu.be/aPxlImNxj5A">
89+
<img src="https://img.youtube.com/vi/aPxlImNxj5A/0.jpg"
90+
alt="Self Checkout with Workflows" width="300" />
9291
</a>
9392
</td>
9493
<!-- Right cell (title, date, description) -->
9594
<td valign="middle">
9695
<strong>
97-
<a href="https://youtu.be/tZa-QgFn7jg">Tutorial: Build a Smart Parking System</a>
96+
<a href="https://youtu.be/aPxlImNxj5A">Tutorial: Build an AI-Powered Self-Serve Checkout</a>
9897
</strong><br />
99-
<strong>Created: 27 Nov 2024</strong><br /><br />
100-
Build a smart parking lot management system using Roboflow Workflows!
101-
This tutorial covers license plate detection with YOLOv8, object tracking
102-
with ByteTrack, and real-time notifications with a Telegram bot.
98+
<strong>Created: 2 Feb 2025</strong><br /><br />
99+
Make a computer vision app that identifies different pieces of hardware, calculates
100+
the total cost, and records the results to a database.
103101
</td>
104102
</tr>
105103

106104
<tr>
107105
<td width="300" valign="top">
108-
<a href="https://youtu.be/VCbcC5OEGRU">
109-
<img src="https://img.youtube.com/vi/VCbcC5OEGRU/0.jpg"
106+
<a href="https://youtu.be/r3Ke7ZEh2Qo">
107+
<img src="https://img.youtube.com/vi/r3Ke7ZEh2Qo/0.jpg"
110108
alt="Workflows Tutorial" width="300" />
111109
</a>
112110
</td>
113111
<td valign="middle">
114112
<strong>
115-
<a href="https://youtu.be/VCbcC5OEGRU">
116-
Tutorial: Build a Traffic Monitoring Application with Workflows
113+
<a href="https://youtu.be/r3Ke7ZEh2Qo">
114+
Tutorial: Intro to Workflows
117115
</a>
118116
</strong><br />
119-
<strong>Created: 22 Oct 2024</strong><br /><br />
117+
<strong>Created: 6 Jan 2025</strong><br /><br />
120118
Learn how to build and deploy Workflows for common use-cases like detecting
121119
vehicles, filtering detections, visualizing results, and calculating dwell
122120
time on a live video stream.
123121
</td>
124122
</tr>
123+
124+
<tr>
125+
<!-- Left cell (thumbnail) -->
126+
<td width="300" valign="top">
127+
<a href="https://youtu.be/tZa-QgFn7jg">
128+
<img src="https://img.youtube.com/vi/tZa-QgFn7jg/0.jpg"
129+
alt="Smart Parking with AI" width="300" />
130+
</a>
131+
</td>
132+
<!-- Right cell (title, date, description) -->
133+
<td valign="middle">
134+
<strong>
135+
<a href="https://youtu.be/tZa-QgFn7jg">Tutorial: Build a Smart Parking System</a>
136+
</strong><br />
137+
<strong>Created: 27 Nov 2024</strong><br /><br />
138+
Build a smart parking lot management system using Roboflow Workflows!
139+
This tutorial covers license plate detection with YOLOv8, object tracking
140+
with ByteTrack, and real-time notifications with a Telegram bot.
141+
</td>
142+
</tr>
125143
</table>
126144

127145
## 📟 connecting via api
@@ -242,7 +260,7 @@ Pass an optional [Roboflow API Key](https://app.roboflow.com/settings/api) to th
242260
platform. When running with an API Key, usage is metered according to
243261
Roboflow's [pricing tiers](https://roboflow.com/pricing).
244262

245-
| | Open Access | With API Key |
263+
| | Open Access | With API Key (Metered) |
246264
|-------------------------|-------------|--------------|
247265
| [Pre-Trained Models](https://inference.roboflow.com/quickstart/aliases/#supported-pre-trained-models) | ✅ | ✅
248266
| [Foundation Models](https://inference.roboflow.com/foundation/about/) | ✅ | ✅

docs/resources.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ hide:
33
- toc
44
---
55

6-
# Other Resources
6+
# More Resources
77

88
<div class="grid cards" markdown>
99

@@ -15,7 +15,7 @@ hide:
1515
the project. It's the place to go to file issues, make feature
1616
requests, or contribute.
1717

18-
[:fontawesome-brands-github: Go to Repo](https://github.com/roboflow/inference)
18+
[:fontawesome-brands-github: Go to Repo](https://github.com/roboflow/inference){:target="_blank"}
1919

2020
- **Roboflow Docs**
2121

@@ -24,30 +24,22 @@ hide:
2424
Roboflow's Platform docs cover using all of the complementary
2525
cloud-connected features to the open source Inference project.
2626

27-
[:fontawesome-solid-book: Go to Docs](https://docs.roboflow.com)
27+
[:fontawesome-solid-book: Go to Docs](https://docs.roboflow.com){:target="_blank"}
2828

2929
- **Roboflow Forum**
3030

3131
---
3232

3333
Get help from and connect with a community of computer vision enthusiasts
3434

35-
[:fontawesome-regular-comment: Go to Forum](https://discuss.roboflow.com)
36-
37-
- **Roboflow Discord**
38-
39-
---
40-
41-
Chat with the Roboflow Community and Team
42-
43-
[:fontawesome-brands-discord: Go to Chat](https://discord.gg/GbfgXGJ8Bk)
35+
[:fontawesome-regular-comment: Go to Forum](https://discuss.roboflow.com){:target="_blank"}
4436

4537
- **Roboflow YouTube**
4638

4739
---
4840

4941
Regular videos with computer Vision news, tutorials, product updates, and more
5042

51-
[:fontawesome-brands-youtube: Go to Channel](https://bit.ly/rf-yt-sub)
43+
[:fontawesome-brands-youtube: Go to Channel](https://bit.ly/rf-yt-sub){:target="_blank"}
5244

5345
</div>

docs/start/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ as starting a Docker container.
8181
!!! info "Self-Hosted Pricing"
8282
Basic usage of self-hosted Inference Servers is completely free.
8383

84-
Workflows that require
84+
Workflows and Models that require
8585
[a Roboflow API Key](https://docs.roboflow.com/api-reference/authentication#retrieve-an-api-key)
8686
to access Roboflow Cloud powered features (for example: the private model repository)
8787
are [metered and consume credits](https://roboflow.com/pricing)

docs/video-tutorials.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,56 @@
11
<div class="tutorial-list">
22
<!-- Tutorial 1 -->
33
<div class="tutorial-item">
4-
<a href="https://youtu.be/tZa-QgFn7jg">
5-
<img src="https://img.youtube.com/vi/tZa-QgFn7jg/0.jpg" alt="Smart Parking with AI" />
4+
<a href="https://youtu.be/aPxlImNxj5A">
5+
<img src="https://img.youtube.com/vi/aPxlImNxj5A/0.jpg" alt="Workflows Tutorial" />
66
</a>
77
<div class="tutorial-content">
8-
<a href="https://youtu.be/tZa-QgFn7jg">
9-
<strong>Tutorial: Build a Smart Parking System</strong>
8+
<a href="https://youtu.be/aPxlImNxj5A">
9+
<strong>Tutorial: Build an AI-Powered Self-Serve Checkout</strong>
1010
</a>
11-
<div><strong>Created: 27 Nov 2024</strong></div>
11+
<div><strong>Created: 2 Feb 2025</strong></div>
1212
<p>
13-
Build a smart parking lot management system using Roboflow Workflows!
14-
This tutorial covers license plate detection with YOLOv8, object tracking
15-
with ByteTrack, and real-time notifications with a Telegram bot.
13+
Make a computer vision app that identifies different pieces of hardware, calculates
14+
the total cost, and records the results to a database.
1615
</p>
1716
</div>
1817
</div>
19-
18+
2019
<!-- Tutorial 2 -->
2120
<div class="tutorial-item">
22-
<a href="https://youtu.be/VCbcC5OEGRU">
23-
<img src="https://img.youtube.com/vi/VCbcC5OEGRU/0.jpg" alt="Workflows Tutorial" />
21+
<a href="https://youtu.be/r3Ke7ZEh2Qo">
22+
<img src="https://img.youtube.com/vi/r3Ke7ZEh2Qo/0.jpg" alt="Workflows Tutorial" />
2423
</a>
2524
<div class="tutorial-content">
26-
<a href="https://youtu.be/VCbcC5OEGRU">
27-
<strong>Tutorial: Build a Traffic Monitoring Application with Workflows</strong>
25+
<a href="https://youtu.be/r3Ke7ZEh2Qo">
26+
<strong>Tutorial: Intro to Workflows</strong>
2827
</a>
29-
<div><strong>Created: 22 Oct 2024</strong></div>
28+
<div><strong>Created: 6 Jan 2025</strong></div>
3029
<p>
3130
Learn how to build and deploy Workflows for common use-cases like detecting
3231
vehicles, filtering detections, visualizing results, and calculating dwell
3332
time on a live video stream.
3433
</p>
3534
</div>
3635
</div>
36+
37+
<!-- Tutorial 3 -->
38+
<div class="tutorial-item">
39+
<a href="https://youtu.be/tZa-QgFn7jg">
40+
<img src="https://img.youtube.com/vi/tZa-QgFn7jg/0.jpg" alt="Smart Parking with AI" />
41+
</a>
42+
<div class="tutorial-content">
43+
<a href="https://youtu.be/tZa-QgFn7jg">
44+
<strong>Tutorial: Build a Smart Parking System</strong>
45+
</a>
46+
<div><strong>Created: 27 Nov 2024</strong></div>
47+
<p>
48+
Build a smart parking lot management system using Roboflow Workflows!
49+
This tutorial covers license plate detection with YOLOv8, object tracking
50+
with ByteTrack, and real-time notifications with a Telegram bot.
51+
</p>
52+
</div>
53+
</div>
3754

3855
<!-- Add more .tutorial-item blocks as needed -->
3956
</div>

docs/workflows/about.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,31 @@ With Workflows, you can:
2121
- Introduce elements of business logic to translate model predictions into your domain language
2222

2323
<div class="button-holder">
24-
<a href="/workflows/blocks/" class="button half-button">Explore all Workflows blocks</a>
24+
<a href="/workflows/blocks/" class="button half-button">Explore all Workflow blocks</a>
2525
<a href="https://app.roboflow.com/workflows" class="button half-button">Begin building with Workflows</a>
2626
</div>
2727

2828
![A license plate detection workflow implemented in Workflows](https://media.roboflow.com/inference/workflow-example.png)
2929

3030

31-
In this section of documentation, we walk through what you need to know to create and run workflows. Let’s get started!
31+
In this section of documentation, we walk through what you need to know to create and run workflows. Let’s get started!
3232

33-
[Create and run a workflow.](/workflows/create_and_run.md)
33+
Next, [create and run a workflow](/workflows/create_and_run.md) or
34+
[browse example Workflows](/workflows/gallery/index.md).
35+
36+
<style>
37+
.button-holder {
38+
margin-bottom: 1.5rem;
39+
}
40+
41+
.button {
42+
background-color: var(--md-primary-fg-color);
43+
display: flex;
44+
padding: 10px;
45+
color: white !important;
46+
border-radius: 5px;
47+
text-align: center;
48+
align-items: center;
49+
justify-content: center;
50+
}
51+
</style>

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ nav:
162162
- Install “bare metal” Inference GPU on Windows: quickstart/inference_gpu_windows.md
163163
- Contribute to Inference: contributing.md
164164
- Changelog: https://github.com/roboflow/inference/releases
165-
- Cookbooks: cookbooks.md
165+
- Examples: workflows/gallery/
166166

167167
theme:
168168
name: 'material'

0 commit comments

Comments
 (0)