Epic: Improve UX of Docs Site

We need to take some time to enhance the user experience of our docs site. Although we have a wealth of information and many useful guides, it isn't always easy to navigate and find the right information. Here I would like to aim to overhaul several key areas of our docs site to make it more intuitive and user-friendly.

Some topics to investigate

Landing page(s)

It might be a good idea to redesign the landing page for better clarity. We could consider creating several different landing pages, each focusing on a different topic. Each page could introduce the CLI for M365 but then focus more on specific areas like SharePoint-based commands or sample scripts. If I remember correctly, @garrytrinder, you mentioned this idea in the past too.

Sample scripts

Our sample scripts need more attention. Although we have a separate section for them, it isn't easy to navigate and find useful scripts. We should improve the organization and accessibility of sample scripts to make it easier for users to find the appropriate ones.

My initial idea is to create a main overview list that displays all our scripts in card format. We could include search functionality and basic filtering options, similar to the landing page of the sample scripts repo. These cards could show detailed information like tags, versions, authors, etc...

Navigating our commands

Enhance the navigation system to allow command pages to be found more efficiently. While commands are logically grouped, the current structure often requires too many clicks to reach the desired command. A redesign should focus on reducing the number of clicks needed, improving search functionality, and adding clear, consistent navigation aids throughout the site.

The main goal of this epic is to simplify the process of finding information. Aiming to create a more intuitive and user-friendly interface and to organize content in a logical and easily navigable manner. Easy... right? 😉

Start by reviewing the docs site's landing pages, sample scripts section, and command navigation described in this epic. The issue names no files, tests, or implementation entry points, so first identify the relevant site structure and break the broad goals into concrete tasks. Done would require a defined, implemented UX improvement that makes documentation and scripts easier to find.