ScottLogic / finos-vuu

Vuu - an open source view server and html 5 based UI system
https://vuu.finos.org
Apache License 2.0
1 stars 0 forks source link

Auto-generate README from docs #122

Open pling-scottlogic opened 9 months ago

pling-scottlogic commented 9 months ago

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

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.

pling-scottlogic commented 8 months ago

Cannot proceed until we know what content is required for the README. Draft PR raised into Finos repo as handover.