MonoGame / docs.monogame.github.io

Other
5 stars 17 forks source link

On building, the site needs to validate all URL's used on the pages to ensure they are valid #11

Closed SimonDarksideJ closed 5 days ago

SimonDarksideJ commented 7 months ago

Link to Document

No response

Description

SUch URL's needing validating are:

The testing only needs to check if the link is valid (non 404) rather than its contents.

AristurtleDev commented 7 months ago

Currently in the process of creating this if ya'll want to assign the issue to me

SimonDarksideJ commented 7 months ago

Slightly extended request on checking links. If possible, can the console dump use different colours for API link errors and Documentation link errors?

Or have two output files for each? @AristurtleDev

AristurtleDev commented 7 months ago

Slightly extended request on checking links. If possible, can the console dump use different colours for API link errors and Documentation link errors?

Or have two output files for each? @AristurtleDev

Yea, that's not an issue. Just to clarify, you want it separated based on the document type, not where the external link is going correct?

For instance, if an /article document links to an /api document, but the link is incorrect, then this should be output as part of the article grouping and not the api grouping.

SimonDarksideJ commented 6 months ago

Currently, the output for each issue is as follows:

But with the screen FULL of these, it is hard to follow through one by one.

But colour coding which reports are /API and which are /Documentation will help, since different teams are viewing each area. SO just a distinction between API and documentation should be sufficient for now.

SimonDarksideJ commented 4 months ago

@AristurtleDev , did this task actually complete or not, can we validate it on the new docfx gen?