Skip to content

Refresh DocFx Engine - Up to latest #1716

@pkbullock

Description

@pkbullock

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 Core SDK (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

  • Adjust or upgrade the Skin template files in the /Docs/Template folder
  • 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.

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions