Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
SimonDarksideJ opened this issue Jan 26, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@SimonDarksideJ
Copy link
Collaborator

Link to Document

No response

Description

SUch URL's needing validating are:

  • Links to external content
  • Links to other pages on the MonoGame docs site
  • Links to images

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

@SimonDarksideJ SimonDarksideJ added the documentation Improvements or additions to documentation label Jan 26, 2024
@AristurtleDev
Copy link
Contributor

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

@SimonDarksideJ
Copy link
Collaborator Author

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
Copy link
Contributor

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
Copy link
Collaborator Author

Currently, the output for each issue is as follows:

  • Detail on each specific issue
  • A collective report of the affected lines

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants