Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate README from docs #122

Open
pling-scottlogic opened this issue Nov 23, 2023 · 1 comment
Open

Auto-generate README from docs #122

pling-scottlogic opened this issue Nov 23, 2023 · 1 comment

Comments

@pling-scottlogic
Copy link

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

  • 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.

@pling-scottlogic
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant