WordPress / WordPress/Documentation-Issue-Tracker

[DevHub] Style issue in the table of contents in summary page in the doc - plugin handbook

Open
#407 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

developer documentation (DevHub)
Dominant language
Shell
Stars
109
Forks
73
PR merge metrics
No merged PRs in 30d

Description

Issue Description

The Table of content in the summary page under the javascript category in the plugin handbook has incorrect formatting. There isn't any spacing around the Topics heading and also there is a list style applied to the list item - More Information

Here is a screenshot of the issue - https://prnt.sc/uYy3OgKZ4Gtk

URL of the Page with the Issue

https://developer.wordpress.org/plugins/javascript/summary/

Section of Page with the issue

Table of content on the right

Why is this a problem?

All the other pages have same styles so to make the styles uniform it should be updated to match the other docs.

Suggested Fix

The heading - Topics is set as h4, changing it to h2 will solve the padding issue. And the list for More Information can be placed inside the main ul tag.

Here is a screenshot of the suggested fix - https://prnt.sc/NNq0xy-gx9-4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the JavaScript summary page at the URL and compare its right-hand table of contents with the other plugin handbook pages. Check the Topics heading spacing and the More Information list structure against the suggested fix. Done means the table of contents matches the surrounding documentation styles.

Written by the indexing model from the issue text.

Assessment

Tech stack
wordpress
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.