Copy the README.md in the build step #469
Draft
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.
As long as we have two copies of the
README.mdfile, there is a chance of misalignment.This PR adds a npm
prebuildstep, which copies the root./README.mdtosrc/assets/Markdown Files/README.mdwhen building.It also adds a warning to the top of the assets readme file, To point developers in the right direction if they open the wrong readme.
If the assets readme is newer than the root readme, the step copies it assets version to a
README.md.bakand outputs a warning.