Treat Invalid Links as Errors #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ta Da @AristurtleDev , workflows enabled :D |
…v/docs.monogame.github.io into feature/link-errors
AristurtleDev
added a commit
to AristurtleDev/MonoGame
that referenced
this pull request
May 23, 2024
The documentation references the CreateDevice() method which is private and throwing an bookmark link error in the documentation repository. Reference: MonoGame/docs.monogame.github.io#14
AristurtleDev
added a commit
to AristurtleDev/MonoGame
that referenced
this pull request
May 23, 2024
Documentation references the `OnComponentRemoved`, `OnComponentAdded` private methods which causes an invalid bookmark link in the documentation repository. Correctly updated these to the correct public event references. Reference: MonoGame/docs.monogame.github.io#14
SimonDarksideJ
approved these changes
May 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the
docfx.jsonconfiguration file to add a rule set that will force a build error if there is an invalid link or uid ref detected on build.Warning
The CI of this PR is going to fail due to invalid UID refs and links. That means this PR is doing what it's supposed to do. Those issues should be resolved in a separate PR.
Related Issues
#11