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

feat: new documentation #164

Merged
merged 395 commits into from
Sep 24, 2024
Merged

feat: new documentation #164

merged 395 commits into from
Sep 24, 2024

Conversation

knzo25
Copy link
Collaborator

@knzo25 knzo25 commented Apr 22, 2024

Description

Related links

Tests performed

Notes for reviewers

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.

  • The PR follows the pull request guidelines.
  • The PR has been properly tested.
  • The PR has been reviewed by the code owners.

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.
  • The PR is ready for merge.

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

@knzo25 knzo25 requested a review from vividf April 22, 2024 10:31
@knzo25 knzo25 self-assigned this Apr 22, 2024
@knzo25 knzo25 marked this pull request as draft April 22, 2024 10:31
@knzo25
Copy link
Collaborator Author

knzo25 commented Apr 22, 2024

Note to self. Rebase if needed

Copy link
Contributor

@vividf vividf left a comment

Choose a reason for hiding this comment

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

LGTM! only one some error that need to fix

sensor/tag_based_sfm_calibrator/README.md Outdated Show resolved Hide resolved
@knzo25
Copy link
Collaborator Author

knzo25 commented Apr 22, 2024

@vividf
LGTM does not apply in this case. We will put all of our documentation here before merging. hence draft

@knzo25
Copy link
Collaborator Author

knzo25 commented Apr 25, 2024

@vividf
General comments:

  • There are several grammar/spelling/redaction/cohesion mistakes. Please, read the documents again, and use a tool like grammarly (you can use it in vscode)
  • During the tutorials, there are recommendations on how to to things good, but things that could go wrong should also be remarked. At the end of the documentation and tutorial, there are no or not enough recommendations / tips / common problems. If there were mentioned in the main document, they should also be put again at the end for emphasis (people usually skip to the end anyways)
  • When possible, center the images. Not are clearly not
  • In the PNP calibrator, for example, when the image does not appear in the UI, the data may not be synchronized

@knzo25 knzo25 requested a review from vividf April 25, 2024 04:59
@knzo25 knzo25 marked this pull request as ready for review April 25, 2024 04:59
@knzo25
Copy link
Collaborator Author

knzo25 commented Jul 22, 2024

@vividf
It has been a week since the review, and still several comments left addressed. We have talked again and again about priorities

… folder (other changes are pre-commit induced)

Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
…as moved into the autoware namespace

Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
knzo25 and others added 7 commits September 3, 2024 15:24
* fix: init tf tree visualization

Signed-off-by: vividf <[email protected]>

* chore: fix error

Signed-off-by: vividf <[email protected]>

---------

Signed-off-by: vividf <[email protected]>
fix: forgot to add a fix to the dot board detector

Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
Signed-off-by: Kenzo Lobos-Tsunekawa <[email protected]>
@knzo25 knzo25 merged commit 69bb747 into tier4/universe Sep 24, 2024
6 of 8 checks passed
@knzo25
Copy link
Collaborator Author

knzo25 commented Sep 24, 2024

I will be force merging this since this was going nowhere and we needed a stable branch eons ago

@knzo25 knzo25 deleted the feature/new_api_documentation branch September 24, 2024 12:33
@vividf vividf restored the feature/new_api_documentation branch September 25, 2024 02:01
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