Skip to content

docs(ekf_localizer): improve ekf_localization readme readability#664

Open
Motsu-san wants to merge 4 commits intoautowarefoundation:mainfrom
Motsu-san:docs/improve_ekf_localization_README_readability
Open

docs(ekf_localizer): improve ekf_localization readme readability#664
Motsu-san wants to merge 4 commits intoautowarefoundation:mainfrom
Motsu-san:docs/improve_ekf_localization_README_readability

Conversation

@Motsu-san
Copy link
Contributor

@Motsu-san Motsu-san commented Oct 6, 2025

Description

This is for improvement the ekf_localization docs readability.

  • Show diagnostic conditions by table.
  • Whiten image background for dark mode appearance.
  • Reflect the changes in this PR.

Before

Diagnostic conditions

image

Equation images

image

After

Diagnostic conditions

Due to the large size, please see this link

Equation images

image

Related links

#668

How was this PR tested?

Please see the github page on this branch on both right mode and dark.

Notes for reviewers

This PR will be merged simultaneously with #668.

Interface changes

None.

Effects on system behavior

None.

@github-actions
Copy link

github-actions bot commented Oct 6, 2025

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@Motsu-san Motsu-san changed the title docs(ekf_localizer)/improve ekf_localization readme readability docs(ekf_localizer): improve ekf_localization readme readability Oct 8, 2025
@Motsu-san Motsu-san marked this pull request as draft October 8, 2025 09:31
@Motsu-san Motsu-san force-pushed the docs/improve_ekf_localization_README_readability branch from 72bdff9 to fdcdd7e Compare October 10, 2025 05:55
@Motsu-san Motsu-san marked this pull request as ready for review October 10, 2025 06:02
@Motsu-san Motsu-san added run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) component:localization Vehicle's position determination in its environment. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned) labels Oct 10, 2025
@codecov
Copy link

codecov bot commented Oct 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.27%. Comparing base (3101380) to head (c497f08).
⚠️ Report is 101 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #664   +/-   ##
=======================================
  Coverage   50.27%   50.27%           
=======================================
  Files         348      348           
  Lines       22023    22023           
  Branches     9795     9795           
=======================================
  Hits        11071    11071           
  Misses       9877     9877           
  Partials     1075     1075           
Flag Coverage Δ *Carryforward flag
daily-humble 50.08% <ø> (-0.01%) ⬇️ Carriedforward from 3101380
daily-jazzy 49.50% <ø> (ø) Carriedforward from 3101380
differential-humble 55.38% <ø> (?)
total 50.28% <ø> (ø) Carriedforward from 3101380
total-humble 50.09% <ø> (ø) Carriedforward from 3101380
total-jazzy 49.50% <ø> (ø) Carriedforward from 3101380

*This pull request uses carry forward flags. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Motsu-san Motsu-san force-pushed the docs/improve_ekf_localization_README_readability branch from e3813c3 to 2973334 Compare November 25, 2025 04:52
@mitsudome-r mitsudome-r force-pushed the docs/improve_ekf_localization_README_readability branch from 2973334 to 4b15bf0 Compare November 26, 2025 03:18
@Motsu-san Motsu-san force-pushed the docs/improve_ekf_localization_README_readability branch from 4b15bf0 to 7b4744e Compare January 6, 2026 03:07
Copy link
Member

Choose a reason for hiding this comment

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

It seems like the file size has increased by more than 3 times (4.79 KB to 16.2 KB). Do you know the reason?
It's not a big size in total anyways so I'm okay to merge, but I just wanted to know if there is a way to keep the file size small as possible.

Copy link
Contributor Author

@Motsu-san Motsu-san Jan 8, 2026

Choose a reason for hiding this comment

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

The PNG format supports background transparency (alpha channel), compressing unnecessary parts (in this case, the white background) as transparent data, so it results in smaller file sizes.
The background is dominant in these images, I think it makes sense that adding color to it makes the file size increased by a few times.

Motsu-san and others added 4 commits January 8, 2026 14:57
Signed-off-by: Motsu-san <83898149+Motsu-san@users.noreply.github.com>
for dark mode appearance

Signed-off-by: Motsu-san <83898149+Motsu-san@users.noreply.github.com>
autowarefoundation#668

Signed-off-by: Motsu-san <83898149+Motsu-san@users.noreply.github.com>
@Motsu-san Motsu-san force-pushed the docs/improve_ekf_localization_README_readability branch from 7b4744e to c497f08 Compare January 8, 2026 05:57
Copy link
Contributor

@sasakisasaki sasakisasaki left a comment

Choose a reason for hiding this comment

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

Thank you very much for nice refactoring! 👍

If I understand correctly, perhaps for the pictures in diagnostics (not formula part), I guess we can omit the pictures. Please see the attached picture. It seems the purpose of pictures in diagnostics is to show the default value, plugin name, ... etc. If so, we can write such the information in the table without providing the pictures.

Perhaps I'm missing something. Your feedback is highly appreciated!

Screenshot from 2026-01-13 20-01-50

@stale
Copy link

stale bot commented Mar 17, 2026

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:localization Vehicle's position determination in its environment. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) status:stale Inactive or outdated issues. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants