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.

Sign up for GitHub

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

Jump to bottom

52/feature/add docs #53

Merged
merged 12 commits into from
Nov 5, 2023
Merged

52/feature/add docs #53

merged 12 commits into from
Nov 5, 2023

Conversation

AaronYoung5
Copy link
Collaborator

@AaronYoung5 AaronYoung5 commented Nov 4, 2023 •
edited
Loading

@AaronYoung5 AaronYoung5 force-pushed the 52/feature/add_docs branch 2 times, most recently from 452f5f8 to 29ebf44 Compare November 4, 2023 17:47
@AaronYoung5 AaronYoung5 self-assigned this Nov 4, 2023
@harryzhang1018
Copy link
Contributor

@AaronYoung5
What's this document about, is this for general introduction for ART or should we create separated document for different cases?

@AaronYoung5
Copy link
Collaborator Author

@AaronYoung5 What's this document about, is this for general introduction for ART or should we create separated document for different cases?

What do you mean? What different cases? These are the documents for the current state of the ART repository, how to use it, etc. We'll update as we change the repo structure to fit the new stuff we talked about.

@harryzhang1018
Copy link
Contributor

@AaronYoung5 What's this document about, is this for general introduction for ART or should we create separated document for different cases?

What do you mean? What different cases? These are the documents for the current state of the ART repository, how to use it, etc. We'll update as we change the repo structure to fit the new stuff we talked about.

Like default ART demo is following the center line of red and green cones, another case might be GPS based tracking, should we mentioned other cases as well or just introduce how to start simulation and how to run A_stack

@AaronYoung5
Copy link
Collaborator Author

@AaronYoung5 What's this document about, is this for general introduction for ART or should we create separated document for different cases?

What do you mean? What different cases? These are the documents for the current state of the ART repository, how to use it, etc. We'll update as we change the repo structure to fit the new stuff we talked about.

Like default ART demo is following the center line of red and green cones, another case might be GPS based tracking, should we mentioned other cases as well or just introduce how to start simulation and how to run A_stack

The current master branch doesn't have those demos. If you want to include those, you should add to the docs when you push.

StefanCaldararu
StefanCaldararu reviewed Nov 4, 2023
View reviewed changes
Copy link
Contributor

@StefanCaldararu StefanCaldararu left a comment

Choose a reason for hiding this comment

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

Lot's of dead links, mostly to internal files which do exist (so kinda confused about that...). Otherwise, only thing would be having links to atk and optix in the quickstart...

docs/README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/design/atk.md Outdated Show resolved Hide resolved
docs/design/dockerfiles.md Outdated Show resolved Hide resolved
docs/design/dockerfiles.md Outdated Show resolved Hide resolved
docs/design/dockerfiles.md Outdated Show resolved Hide resolved
docs/design/ros_workspace.md Outdated Show resolved Hide resolved
@StefanCaldararu
Copy link
Contributor

oh also maybe add a section for building the bluespace_ai_xsens_mti_driver in the quickstart doc? or maybe in FAQ? otherwise ppl will be confused why it doesn't work

StefanCaldararu
StefanCaldararu previously approved these changes Nov 5, 2023
View reviewed changes
Copy link
Contributor

@StefanCaldararu StefanCaldararu left a comment

Choose a reason for hiding this comment

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

Looks good to me

@AaronYoung5
Copy link
Collaborator Author

@StefanCaldararu made some edits related to your previous comments.

@StefanCaldararu
Copy link
Contributor

StefanCaldararu commented Nov 5, 2023 •
edited
Loading

@AaronYoung5 why did the atk.yml file change? otherwise looks good to me

@AaronYoung5
Copy link
Collaborator Author

@AaronYoung5 why did the atk.yml file change? otherwise looks good to me

Damn you're good. I updated atk a while back so those lines aren't needed anymore. Should I move to a separate PR?

@StefanCaldararu
Copy link
Contributor

@AaronYoung5 why did the atk.yml file change? otherwise looks good to me

Damn you're good. I updated atk a while back so those lines aren't needed anymore. Should I move to a separate PR?

nah it's fine imo

StefanCaldararu
StefanCaldararu approved these changes Nov 5, 2023
View reviewed changes
Copy link
Contributor

@StefanCaldararu StefanCaldararu left a comment

Choose a reason for hiding this comment

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

looks good

@AaronYoung5 AaronYoung5 merged commit 3a0ed40 into master Nov 5, 2023
1 check passed
@AaronYoung5 AaronYoung5 deleted the 52/feature/add_docs branch November 5, 2023 17:27
AaronYoung5 added a commit that referenced this pull request Nov 5, 2023
@AaronYoung5
52/feature/add docs (#53)
5ac966c 
* Pre-commit

* Restructured

* Working through docs

* Added quick start

* Updated docs

* Updated docs

* Added docs for vehicle computers

* Updated .pre-commit-config.yaml

* Fixed links

* Now will search are markdown files for deadlinks

* Updated pre-commit to fix github ci error

* Updated docs

---------

Co-authored-by: AaronYoung5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StefanCaldararu StefanCaldararu StefanCaldararu approved these changes

@harryzhang1018 harryzhang1018 Awaiting requested review from harryzhang1018

@zzhou292 zzhou292 Awaiting requested review from zzhou292

@srirama02 srirama02 Awaiting requested review from srirama02

Assignees

@AaronYoung5 AaronYoung5

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AaronYoung5 @harryzhang1018 @StefanCaldararu