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

Help sidebar: Move docs to docs repo & Integrate them into the UI #2253

Merged
merged 11 commits into from
Jan 27, 2024

Conversation

florian-h05
Copy link
Contributor

@florian-h05 florian-h05 commented Jan 3, 2024

Follow-up for #2088.
Depends on openhab/openhab-docs#2199.

Also add the help sidebar button to the settings and list pages where it is missing.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
TODO: Remove this before contributing to the UI codebase.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Copy link

relativeci bot commented Jan 3, 2024

Job #1371: Bundle Size — 15.83MiB (-0.09%).

0340a06(current) vs f493e97 main#1370(baseline)

Warning

Bundle contains 16 duplicate packages – View duplicate packages

Bundle metrics  Change 3 changes Improvement 1 improvement
                 Current
Job #1371
     Baseline
Job #1370
Improvement  Initial JS 1.89MiB(-0.7%) 1.9MiB
No change  Initial CSS 609.81KiB 609.81KiB
Change  Cache Invalidation 93.88% 93.98%
No change  Chunks 217 217
No change  Assets 683 683
Change  Modules 3012(-0.79%) 3036
No change  Duplicate Modules 170 170
No change  Duplicate Code 1.6% 1.6%
No change  Packages 152 152
No change  Duplicate Packages 16 16
Bundle size by type  Change 2 changes Improvement 2 improvements
                 Current
Job #1371
     Baseline
Job #1370
Improvement  JS 9.3MiB (-0.13%) 9.31MiB
Improvement  Other 4.75MiB (-0.06%) 4.75MiB
Not changed  CSS 861.35KiB 861.35KiB
Not changed  Fonts 526.1KiB 526.1KiB
Not changed  Media 295.6KiB 295.6KiB
Not changed  IMG 140.74KiB 140.74KiB
Not changed  HTML 1.23KiB 1.23KiB

View job #1371 reportView florian-h05:help-sidebar-docs-in... branch activityView project dashboard

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
@florian-h05 florian-h05 marked this pull request as ready for review January 26, 2024 23:47
@florian-h05 florian-h05 requested a review from a team as a code owner January 26, 2024 23:47
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
@stefan-hoehn
Copy link
Contributor

I think with the latest change you pushed, which we discussed offline, covering the non-availability of the internet, it is looking pretty good. I also looked through the code and I don't see any obvious issue. So, I think we are good to go.

This PR, based on the related restructuring of the docs sidebar, is a great step forward for context sensitive in the UI and a good integration into the online docs.
Thanks, Florian (not only for the implementation but also for the contribution of the related docs)!

Copy link
Contributor

@stefan-hoehn stefan-hoehn left a comment

Choose a reason for hiding this comment

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

The code looks good to me. I don't see any obvious issue.

@florian-h05 florian-h05 merged commit 8b6b262 into openhab:main Jan 27, 2024
6 checks passed
@florian-h05 florian-h05 deleted the help-sidebar-docs-integration branch January 27, 2024 11:01
@florian-h05 florian-h05 added this to the 4.2 milestone Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request main ui Main UI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants