VUU-1118: Auto-generate README from docs #1119
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.
Description
Adds a new GitHub action to automatically update the project's README file whenever changes are made to the relevant files in the
docs
folder. This relevant files are specified in a text file, which supports the use of wildcards.Change List
docs
folderTo Do
docs
folder to allow appropriate concatenationreadme_contents.txt
to specify relevant docs files/sub-foldersREADME_AUTO.md
withREADME.md
README_AUTO.md