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

DOC: content is incomplete #1

Open
bsipocz opened this issue Nov 4, 2024 · 2 comments
Open

DOC: content is incomplete #1

bsipocz opened this issue Nov 4, 2024 · 2 comments

Comments

@bsipocz
Copy link
Member

bsipocz commented Nov 4, 2024

The readme looks useful, however it is totally outdated with a lot of presentations missing. So we either need to

  • at minimum, add a link to zenodo, or the other places where there are more recent slides/etc.

  • keep the repo up-to-date and add a new line whenever a new entry is added to the content. while I don't feel that this is the right platform/location for the actual slides, keeping track of abstracts and list of talks (with list to the slides elsewhere) would potentially be still useful.

  • come up with a way to auto generate a README/TOC

OR

  • delete the current content of the readme and write up a very generic overview in a paragraph or so. At the end of the day the naming of files/directories are should be clear enough.
@Arielle-Bennett
Copy link
Contributor

I think I agree with the second approach @bsipocz - it would make sense to have things listed in files in the repo maybe instead? Or a shared spreadsheet link which is easier to organise.

@aleesteele I think we have one of these already IIRC, could you update the Readme with it?

@bsipocz
Copy link
Member Author

bsipocz commented Dec 13, 2024

Since I wrote this issue it became apparent that it's in fact the repo that's missing the presentations rather than the readme being totally outdated with the repo's content.

So maybe just a sentence or two that links to a good zenodo search for the newer slidedecks would suffice.

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

2 participants