Documentation-Issue-Tracker icon indicating copy to clipboard operation
Documentation-Issue-Tracker copied to clipboard

Sidebar Content Layout Problem

Open truptikanzariya opened this issue 10 months ago • 2 comments

Issue Description

The sidebar layout on this page is inconsistent with the layout on other pages, leading to discrepancies in design and user experience. The HTML structure for the sidebar content seems to differ, which may be the root cause of the issue.

Image

URL of the Page with the Issue

URL : https://make.wordpress.org/cli/handbook/references/documentation-standards/

Section of Page with the issue

The issue is located in the sidebar navigation section, specifically within the table of contents structure.

Why is this a problem?

Inconsistent sidebar layouts can confuse users and disrupt navigation, making it harder to locate content efficiently. Additionally, varying HTML structures may impact the uniformity of styling and functionality across the website.

Suggested Fix

To resolve the issue, standardize the sidebar's HTML structure to align with the format used on other pages. The structure should follow a consistent nested hierarchy, such as:

    • Command annotation
    • Class annotation
  • Messages within command execution
  • Messages within command execution
By maintaining this structure, the sidebar content will align properly and remain consistent across all pages.

Thank you...

truptikanzariya avatar Jan 13 '25 08:01 truptikanzariya

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

github-actions[bot] avatar Jan 13 '25 08:01 github-actions[bot]

@truptikanzariya Open the issue in the WP-CLI repository: https://github.com/wp-cli/handbook/issues

I believe this problem is due to the fact that the original article does not have the correct HTML structure.

h3: Command annotation h3: Class annotation h2: Messages within command execution h2: Messages within command execution

atachibana avatar Jan 13 '25 12:01 atachibana