You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In #109, we found a way to use GitHub actions to auto-generate a README file from a specified list of markdown files in the project repo. We now need to productionise this proof of concept.
Work Required
Add the following files from the prototype branch (SLVUU109-combine-docs):
generate-readme.sh
generate-readme.yml
readme_contents.txt
Change any references to README_AUTO.md with README.md
Edit readme_contents.txt to specify the intended list of files to be included
❓ Which files/folders are to be included?
Edit generate-readme.yml to generate any further commentary/intro that may be required
Notes
If it is neccessary to include a significant amount of markdown content to the README that is not intended for the Docusaurus site, this can be written in .md files stored outside of the docs folder, and referenced in readme_contents.txt.
The text was updated successfully, but these errors were encountered:
Background
In #109, we found a way to use GitHub actions to auto-generate a README file from a specified list of markdown files in the project repo. We now need to productionise this proof of concept.
Work Required
SLVUU109-combine-docs
):generate-readme.sh
generate-readme.yml
readme_contents.txt
README_AUTO.md
withREADME.md
readme_contents.txt
to specify the intended list of files to be includedgenerate-readme.yml
to generate any further commentary/intro that may be requiredNotes
If it is neccessary to include a significant amount of markdown content to the README that is not intended for the Docusaurus site, this can be written in
.md
files stored outside of thedocs
folder, and referenced inreadme_contents.txt
.The text was updated successfully, but these errors were encountered: