Skip to content

Conversation

@josh-wong
Copy link
Member

Description

This PR adds links to category overview pages for each first-level and second-level category in the sidebar navigation on the docs site. These category overview pages include an overview of the category and are based on the current structure of the docs site.

A category overview is a page that appears when a visitor selects a category in the sidebar navigation.

  • Current behavior: The current behavior is that those categories only expand or collapse when pressed.
  • New behavior: By adding these overview pages, we can assign these pages to categories so that readers can select categories to see what the category or sub-category is about. In addition, we can provide links to sections of our docs, which is also more user friendly when providing support.

Note

For now, only the first-level and second-level categories will have index pages. In addition, the Troubleshoot category and categories named Reference will not have overview pages.

In addition, this PR fixes some awkward behavior with making some of the sidebar navigation arrows larger after applying links to the categories.

Related issues and/or PRs

The following PRs add the category overview pages for versions 3.12 to 3.14:

Changes made

  • Updated the sidebar navigation to include links to the new (or updated) category overview pages.
  • Added a style to shrink the arrows on categories in the sidebar navigation.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong josh-wong added the sidebar navigation Updates to the sidebar navigation label Jan 23, 2025
@josh-wong josh-wong self-assigned this Jan 23, 2025
@josh-wong josh-wong merged commit b6db600 into main Jan 23, 2025
1 check passed
@josh-wong josh-wong deleted the add-links-to-category-indexes branch January 23, 2025 08:45
@josh-wong josh-wong added the improvement Improvements made to an existing feature label Jan 23, 2025
josh-wong added a commit that referenced this pull request May 14, 2025
…es in sidebar navigation (#869)

* Add links to category overview pages (English)

* Add links to category overview pages (Japanese)

* Add another style to shrink arrow in sidebar nav

Add a style to make the arrow in the sidebar navigation smaller. This is necessary because making only some categories clickable indexes causes the icon to revert to the default size.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvements made to an existing feature sidebar navigation Updates to the sidebar navigation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant