Issues

High Prio

• Setup Docusaurs work branch #4535
• Docusaurs: Script the old syntaxes to the new form #4574 Ready to go!
• Docusaurs: Update the footer UI & mobile menus #4611
• Docusaurs: Resolve 'Meet the team' page #4587
• Docusaurs: Add index page to sample-scripts #4640
• Docusaurs: Adjust --help print to accommodate different syntaxes #4673 Ready to go! Still need to write the tests 😅
• Docusaurs: Update sidebar.js to manually order cmd folder content #4743
• Docusaurs: Modify GitHub actions to build & test #4754
• Docusaurs: Integrate Mendable in docs #4765
• Add Google Analytics to Docusaurus docs #4792

High Prio After Deploy

• Docusaurs: Setup the Algolia search engine #4741

Low Prio

• Docusaurs: Add more white space to the pages for readability #4575
• Docusaurs: Check & adjust the accessibility #4742
• Docusaurs: Validate the double npm package approach #4744
• Bug report: Docusaurus go to top button is hidden by mendable button #4806
• Docusaurs: Add GitHub stats counter to the navbar #4880
• Docusaurus: Fix syntax highlighting in code blocks #4883
• Docusaurs: Include Discord announcement bar #4931

Info:

For our docs, we will be changing the current Python-based SSG to a JavaScript one, Docusaurus to be more specific. This has been concluded from our recent discussion #4283 (comment).

Docusaurus comes with a bunch of out-of-box features that align well with our current docs setup. Pages are written in MarkDown, layered navigation, table of content for each page, and much more. We currently have a PoC running where you can look at the new UI/UX.

PoC

Regarding the PoC, an example of our docs is available at https://jwaegebaert.github.io/cli-microsoft365-docusaurus/
I've built it with version 6.1 and the source code is available in the repo https://github.com/Jwaegebaert/cli-microsoft365-docusaurus.

There are a few things to keep in mind when looking through the PoC.

• The search engine isn't enabled because we'll look into making our search engine with Azure Cognitive Search.
• The admonition syntax is different from MKDocs so they won't be rendered correctly.
• The same goes for the tabs we use with the command outputs but I've refactored all the Planner commands so be sure to take a peak there. planner bucket add
• Navigation has been modified a bit with landing pages for the categories. planner
• Navigation in mobile view doesn't look super clean yet, the same goes for the footer

ToDo

• Set up a search engine with Azure Cognitive Search. Ref: Migrate the docs to a JS based Static Site Generator #4283 (reply in thread)
• Resolve the admonition syntaxes. The admonition syntax is different from MKDocs so they won't be rendered correctly.
• Resolve the command output syntaxes. Take a look at planner bucket add to see how this has been achieved.
• Resolve the embeddings used for global options to the new syntax
• Add more white space to the pages for readability. Ref: Migrate the docs to a JS based Static Site Generator #4283 (reply in thread)
• Modify the footer UI
• Modify the mobile navigation
• Remove the category landing pages. Ref: Migrate the docs to a JS based Static Site Generator #4283 (reply in thread)
• Integrate with our Google Analytics (final step before going live)
• Update GitHub workflow to publish docs using Docusaurus
• Update the option descriptions for all the commands as they don't look right