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

Add documentation index page to the sidebar when it's the only page #1472

Conversation

caendesilva
Copy link
Member

Abstract

Automatically include the index page in the documentation sidebar when it is the only page present. This ensures the sidebar is not empty for a single-page documentation site, providing a more user-friendly experience.

Comparison

Before

localhost_8080_docs_index html(1280x720) (1)

After

localhost_8080_docs_index html(1280x720)

Copy link

codecov bot commented Nov 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (34eaffb) 100.00% compared to head (300694c) 100.00%.

Additional details and impacted files
@@              Coverage Diff              @@
##              master     #1472     +/-   ##
=============================================
  Coverage     100.00%   100.00%             
- Complexity      1728      3460   +1732     
=============================================
  Files            180       360    +180     
  Lines           4693      9390   +4697     
=============================================
+ Hits            4693      9390   +4697     

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

Automatically include the index page in the documentation sidebar when it is the only page present. This ensures the sidebar is not empty for a single-page documentation site, providing a more user-friendly experience.
@caendesilva caendesilva force-pushed the add-documentation-index-page-to-sidebar-when-it-is-the-only-page branch from 7ffa427 to 300694c Compare November 26, 2023 16:09
@caendesilva caendesilva marked this pull request as ready for review November 26, 2023 16:32
@caendesilva caendesilva merged commit a524c17 into master Nov 26, 2023
19 checks passed
@caendesilva caendesilva deleted the add-documentation-index-page-to-sidebar-when-it-is-the-only-page branch November 26, 2023 16:32
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.

1 participant