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 parameter tables generated from schemas per vendor and sensor model #195

Merged
merged 22 commits into from
Nov 11, 2024

Conversation

mojomex
Copy link
Collaborator

@mojomex mojomex commented Sep 11, 2024

PR Type

  • Improvement

Description

⚠️ Merge #194 first! ⚠️

This PR adds

  • a modified version of Autoware.Universe's mkdocs_macros.py to add support for Markdown table generation from JSON schemas
  • a page per vendor with common parameters
  • a page per sensor with all the parameters (and value ranges) supported by that sensor

image

Review Procedure

Render the docs and confirm the tables are complete and correct.

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

@mojomex mojomex self-assigned this Sep 11, 2024
@mojomex mojomex marked this pull request as draft September 13, 2024 00:54
@mojomex mojomex marked this pull request as ready for review September 13, 2024 08:01
@mojomex mojomex requested a review from drwnz September 13, 2024 08:01
@codecov-commenter
Copy link

codecov-commenter commented Sep 17, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@528b732). Learn more about missing BASE report.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##             develop    #195   +/-   ##
=========================================
  Coverage           ?   0.00%           
=========================================
  Files              ?      34           
  Lines              ?    3605           
  Branches           ?       0           
=========================================
  Hits               ?       0           
  Misses             ?    3605           
  Partials           ?       0           
Flag Coverage Δ
differential 0.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…in navigation (tier4#194)

* docs: add API reference page and add things like class references to nav

* Apply suggestions from code review

Co-authored-by: David Wong <33114676+drwnz@users.noreply.github.com>

* docs: fix case style of API reference heading

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

---------

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Co-authored-by: David Wong <33114676+drwnz@users.noreply.github.com>
Copy link
Collaborator

@drwnz drwnz left a comment

Choose a reason for hiding this comment

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

Mostly looks great, some minor suggested changes.
The only other thing that I noticed, was that generally parameter tables are built from the schema except for Hesai common which has extra (very detailed) explanation.
It might be more consistent to generate Hesai common the same as the others and add an explanation below the parameter table. This could also be done for the Nebula common parameters as well.

docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters.md Outdated Show resolved Hide resolved
docs/parameters/vendors/hesai/common.md Outdated Show resolved Hide resolved
docs/parameters/vendors/hesai/common.md Outdated Show resolved Hide resolved
@mojomex
Copy link
Collaborator Author

mojomex commented Nov 6, 2024

The Hesai table I can do.

For the common one, there is almost no overlap between all sensors, so I would have to create around 3 separate schemas to cover everything (e..g CAN vs. IP, scan_phase vs cut angle etc.). I don't think it would be a particularly nice solution.

@mojomex mojomex requested a review from drwnz November 6, 2024 13:49
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
@mojomex
Copy link
Collaborator Author

mojomex commented Nov 7, 2024

I added the Hesai table, please check @drwnz 🙏

image

@mojomex mojomex changed the base branch from develop to main November 8, 2024 07:49
Copy link
Collaborator

@drwnz drwnz left a comment

Choose a reason for hiding this comment

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

LGTM, nice :)

@mojomex mojomex merged commit 7c2f90b into tier4:main Nov 11, 2024
2 of 3 checks passed
@mojomex mojomex deleted the docs-parameters branch November 11, 2024 05:30
mojomex added a commit to mojomex/nebula that referenced this pull request Nov 12, 2024
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
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.

3 participants