PSAppDeployToolkit / PSAppDeployToolkit/website

[Feature] Add third level headers to the doc page table of contents to improve navigation

Open Beginner friendly
#430 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
5
Forks
7
Avg merge
3h 46m
Merged PRs (30d)
5

Description

Can you please consider adding the third level of headings in the docs pages to the table of contents, some of the larger pages are also the ones I reference the most like Start-ADTProcess and Start-ADTMsiProcess, being able to navigate directly to the necessary parameter would significantly improve the end user experience for the site on the longer pages.

Example of this in action from the Docusaurus Powershell site

https://github.com/PSAppDeployToolkit/website/blob/24c410db6da34c52a461dde4f34a37c37208296e/docusaurus.config.js#L127-L130

Contributor guide

No contributing guide indexed for this repository

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

Start with docusaurus.config.js around the linked table-of-contents configuration, then inspect the Start-ADTProcess and Start-ADTMsiProcess documentation pages to see their heading structure. Enable third-level headings in the docs table of contents and verify that parameter sections are directly navigable on the longer pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.