Automatically Inject MonoGame Version In Documentation#209
Open
AristurtleDev wants to merge 5 commits intoMonoGame:mainfrom
Open
Automatically Inject MonoGame Version In Documentation#209AristurtleDev wants to merge 5 commits intoMonoGame:mainfrom
AristurtleDev wants to merge 5 commits intoMonoGame:mainfrom
Conversation
…reflect current version
Collaborator
|
While in principle, I agree with this approach to simplify versioning in the documentation. However, there are a few areas where this has implemented which is not fit for purpose, such as:
Please review and update as appropriate. |
This file contains hidden or 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
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 adds a new feature to the documentation where using the tokens
{{mgVersion}}or{{mgDevelopVersion}}will automatically inject the version configured in the newmgversion.jsonfile.The changes include:
mgversion.jsoncontainingmgVersionandmgDevelopVersion.docfx.jsonandci.docfx.jsonto includemgversion.jsonviaglobalMetadataFiles.conceptual.extension.jsto replace all occurrences of{{mgVersion}}and{{mgDevelopVersion}}in the Markdown content with the configured values.This ensures that the documentation always reflects the correct MonoGame version and makes it easy to update the versions in one place.
Note:
@SimonDarksideJ: There are a couple of places where I was unsure if the documentation should always reflect the current version number of if it should remain hard coded. Specifically in the migration document here
docs.monogame.github.io/articles/migration/migrate_38.md
Lines 136 to 139 in bbca6d5
docs.monogame.github.io/articles/migration/migrate_38.md
Lines 155 to 159 in bbca6d5
Related Issues