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(readme): enrich readme #6518

Merged
merged 6 commits into from
Feb 29, 2024
Merged

Conversation

TakaHoribe
Copy link
Contributor

@TakaHoribe TakaHoribe commented Feb 29, 2024

Description

update readme with a picture.

Tests performed

None

Effects on system behavior

None

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 PR 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.

@github-actions github-actions bot added the type:documentation Creating or refining documentation. (auto-assigned) label Feb 29, 2024
Signed-off-by: Takamasa Horibe <[email protected]>
@xmfcx xmfcx changed the title dock(readme): update readme docs(readme): update readme Feb 29, 2024
Signed-off-by: Takamasa Horibe <[email protected]>
@TakaHoribe TakaHoribe added the run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Feb 29, 2024
@TakaHoribe TakaHoribe requested a review from xmfcx February 29, 2024 10:17
@TakaHoribe TakaHoribe changed the title docs(readme): update readme docs(readme): enrich readme Feb 29, 2024
Copy link

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: M. Fatih Cırıt <[email protected]>
@xmfcx
Copy link
Contributor

xmfcx commented Feb 29, 2024

Thanks @TakaHoribe -san for the updated readme, I've added some suggestions after reviewing with chagpt. I changed a lot but I hope you like them too.

TakaHoribe and others added 2 commits February 29, 2024 19:32
Co-authored-by: M. Fatih Cırıt <[email protected]>
Co-authored-by: M. Fatih Cırıt <[email protected]>
@TakaHoribe
Copy link
Contributor Author

@xmfcx Thank you! It helps a lot!

@xmfcx xmfcx added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Feb 29, 2024
@TakaHoribe
Copy link
Contributor Author

@xmfcx @mitsudome-r This is a related PR in autoware-documentation: autowarefoundation/autoware-documentation#526

@TakaHoribe TakaHoribe requested a review from xmfcx February 29, 2024 10:35
@TakaHoribe
Copy link
Contributor Author

hmm, seems pre-commit does not allow to use ! in the section title
image

Copy link
Contributor

@xmfcx xmfcx left a comment

Choose a reason for hiding this comment

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

The page looks good, thanks!

@xmfcx xmfcx merged commit d5c7e61 into autowarefoundation:main Feb 29, 2024
15 checks passed
HansRobo pushed a commit that referenced this pull request Mar 12, 2024
Signed-off-by: Takamasa Horibe <[email protected]>
Signed-off-by: Kotaro Yoshimoto <[email protected]>
kaigohirao pushed a commit to kaigohirao/autoware.universe that referenced this pull request Mar 22, 2024
Signed-off-by: Takamasa Horibe <[email protected]>
Signed-off-by: kaigohirao <[email protected]>
karishma1911 pushed a commit to Interplai/autoware.universe that referenced this pull request Jun 3, 2024
@TakaHoribe TakaHoribe deleted the update-front-page branch July 31, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants