Details

• On PnP Script Samples, I have updated to the latest engine, here its currently using 2.59.2 (Apr 2022), 2.78.x is the latest. The biggest hurdle recently was the skin on the site needed to be rebuilt which is done now.
• Other repos as undergoing a larger visual change so we need to decide to adopt that in the update process or stick with a simplier layout, e.g. PnP Framework (Simple skin, as-is now) or https://pnp.github.io/sp-dev-fx-webparts/ (No skin for this atm)
• The GitHub runner was locked to Ubuntu 22.04 to prevent it breaking due to the age of the version of .Net required to run DocFx. Latest DocFx uses DotNet Core now and will support latest Ubuntu runner.

Anticipated Tasks

• Import Skin template from PnP Script Samples and adjust colouring to match current (red)
• Adjust DocFx.yml to unlock the Ubuntu version
• Test locally and rebuild docs site. (Should appear the same as is)

Bit of background

What is DocFx

DocFx is an open-source documentation generation tool developed by Microsoft. It allows you to create technical documentation from source code and markdown files. DocFx supports multiple programming languages and can generate static websites, PDF outputs, and API documentation by parsing XML comments and markdown content. It’s widely used for building developer guides and API references in a consistent, automated way.

Key Features

• Multi-language support: Generates documentation for multiple programming languages.
• Markdown integration: Combines Markdown content with API documentation.
• Static site generation: Outputs documentation as a static website.
• PDF export: Supports generating PDF versions of documentation.
• Customizable templates: Allows branding and layout customization.
• Cross-platform: Works on Windows, macOS, and Linux.