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: add reference hardware documentation #405

Merged

Conversation

NilaySener
Copy link
Contributor

@NilaySener NilaySener commented Jun 20, 2023

Description

The Autoware documentation has been updated with a new page titled "Reference HW " which includes information on various hardware components. This pull request aims to incorporate these additions into the documentation. The added content covers AD computers, LiDARs, RADARs, CAMERAs, thermal CAMERAs, IMU, AHRS & GNSS/INS sensors, vehicle drive-by-wire suppliers, vehicle platform suppliers, remote drive solutions, and a full drivers list. This PR enhances the documentation by providing valuable information about these hardware options for Autoware users.

The referenced HW document is here.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@NilaySener NilaySener added the type:documentation Creating or refining documentation. label Jun 20, 2023
@NilaySener NilaySener requested review from xmfcx and armaganarsln June 20, 2023 09:04
@NilaySener NilaySener self-assigned this Jun 20, 2023
@NilaySener NilaySener requested a review from kenji-miyake June 20, 2023 09:05
@xmfcx xmfcx added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Jun 20, 2023
@xmfcx
Copy link
Contributor

xmfcx commented Jun 20, 2023

Can you also share the original HW document link in the PR description?

@xmfcx
Copy link
Contributor

xmfcx commented Jun 20, 2023

Thank you for the comprehensive documentation!

Could you go over pre-commit.ci check errors?
Also could you also sign the commits to pass the DCO test?

@NilaySener NilaySener force-pushed the add-reference-hw-design branch from 73f1fef to 6704afd Compare June 20, 2023 12:13
Signed-off-by: Nilay Şener <nilay@leodrive.ai>
@NilaySener NilaySener force-pushed the add-reference-hw-design branch from 6704afd to db3c119 Compare June 20, 2023 12:27
NilaySener and others added 4 commits June 20, 2023 17:04
Signed-off-by: Nilay Şener <nilay@leodrive.ai>
Signed-off-by: Nilay Şener <nilay@leodrive.ai>
Signed-off-by: Nilay Şener <nilay@leodrive.ai>
Copy link
Member

@mitsudome-r mitsudome-r left a comment

Choose a reason for hiding this comment

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

Thanks for making the PR. I made some review comments.

docs/reference-hw/lidars.md Outdated Show resolved Hide resolved
docs/reference-hw/lidars.md Show resolved Hide resolved
docs/reference-hw/remote_drive.md Outdated Show resolved Hide resolved
Copy link
Member

@mitsudome-r mitsudome-r left a comment

Choose a reason for hiding this comment

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

LGTM

@mitsudome-r mitsudome-r merged commit 3bbcbd1 into autowarefoundation:main Jul 19, 2023
alanmengg pushed a commit to alanmengg/autoware-documentation that referenced this pull request Aug 2, 2023
* docs: add reference hardware documentation

Signed-off-by: Nilay Şener <nilay@leodrive.ai>

* pre-commit fixes

Signed-off-by: Nilay Şener <nilay@leodrive.ai>

* style(pre-commit): autofix

* update auto-fix

Signed-off-by: Nilay Şener <nilay@leodrive.ai>

* update broken links

Signed-off-by: Nilay Şener <nilay@leodrive.ai>

* fix typos and tables

Signed-off-by: Nilay Şener <nilay@leodrive.ai>

* style(pre-commit): autofix

---------

Signed-off-by: Nilay Şener <nilay@leodrive.ai>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
Signed-off-by: guiping meng <alan.meng@autocore.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants