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.

Sign up for GitHub

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

Jump to bottom

Add documentation #32

Open
Molkree opened this issue Jul 17, 2021 · 2 comments
Open

Add documentation #32

Molkree opened this issue Jul 17, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Molkree
Copy link
Member

Molkree commented Jul 17, 2021

  • Start with repo readme, is it already outdated.
  • Maybe create directories for each data source/algorithm, each with a short how-to readme?
@Molkree Molkree added the documentation Improvements or additions to documentation label Jul 17, 2021
@valentina-s
Copy link
Collaborator

Yes, main readme can describe the purpose (since not everybody understands github actions), and then you can have links to subfolder readmes with more details. It would be good to have instructions like:

  • here is how to run the workflow with default parameters
  • here is where to change stuff to run the workflow with new parameters.

@Molkree Molkree mentioned this issue Aug 23, 2021
Merged
@sahilempire
Copy link

I want to work on this issue, I have checked all the things which should be present in the README file.
So please assign me, to this issue. @Molkree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@valentina-s @Molkree @sahilempire