Skip to content

add docs folder#8

Merged
maxgallup merged 2 commits into
mainfrom
chore/verify-service
Mar 10, 2025
Merged

add docs folder#8
maxgallup merged 2 commits into
mainfrom
chore/verify-service

Conversation

@spaghetti-enjoyer

Copy link
Copy Markdown
Contributor

Added a docs folder with some explanation, please leave feedback

Comment thread docs/01-overview.md
@@ -0,0 +1,2 @@
# Overview

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a bit more here talking about very very basically what a PID Controller is and linking the wikipedia page?

see what i did for overview at VU-ASE/imaging#5

Comment thread docs/02-usage.md Outdated

The first point in the array of trajectory points is the identified middle of the visible part of the track. (see image below). You can, for example, compare value of its `x` coordinate to the middle of the frame to see if the car is offset towards the left or right side of the track.

![alt text](blob_with_line.png)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could make this a link to a image online? see I changed it in VU-ASE/imaging#5

Also, make the alt_text semi-useful please :)

Comment thread docs/blob_with_line.png Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can be deleted

@maxgallup
maxgallup merged commit 51ff162 into main Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants