Support for MSDocs for more than links verification?

[Youssef1313]

I'm thinking of extending this workflow (may or may not be in a separate fork) for things specific to MSDocs repositories.

Things on top of my mind:

• Verify redirection correctness of a PR

  Whenever a PR have a deleted file and there is no proper redirection added, then fail. In rare cases where this might be intentional, the failure can be ignored.

• Added file is missing in ToC.

  Whenever a PR adds a new file, make sure it exists in ToC.

• Support link verification for ToCs.

  Same as done with markdown files.

• OPB doesn't seem to validate old code snippets syntax ([!code-LANG]) correctly. If it's not going to be fixed at the official build, I may consider that too (I haven't checked the new syntax)

There are possibly few other cases to.

Note: I may not be able to do this very soon.

@gewarren @BillWagner @adegeo @IEvangelist What are your thoughts here? Is this something valuable for the dotnet/docs team (and potentially other docs repositories)?

---

Working on this in a fork.

• Redirection verification

  Partially done. It's currently heuristic-based though. It should be done more reliably.

• New files added to ToC

  Nothing done yet.

• Validate TOC links.

  Nothing done yet.

[IEvangelist]

At the very least for directs you may consider looking at, https://github.com/microsoft/vscode-docs-authoring/tree/main/packages/docs-markdown/src/controllers/redirects - which is from the docs authoring pack.

[gewarren]

Awesome idea. The redirect-checking functionality would be useful across all docs repos. In repos that use PRMerger, the editors currently check manually for working redirects, so automation would be awesome. On that one, make sure it covers renamed files too (they also need a redirect).

Verifying that new files are added to the TOC would also be useful (happens quite frequently). And checking links from the TOC doesn't hurt either. I'd put lowest priority on the snippet check since the OPS team might/should fix that.

[Youssef1313]

Thanks @IEvangelist @gewarren. I'll see how this goes.