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

online docu in README.md #52

Open

2 of 4 tasks

martin-raden opened this issue Jun 26, 2023 · 0 comments

Member

martin-raden commented Jun 26, 2023

Hi all,

I have

enabled github pages export to provide a documentation view without the github details
added a workflow figure and a link to the github page

I think we need:

a (rough) "table of content" to ease the browsing of the documentation, such that one can jump to a point of interest
some general workflow details (as given in the paper; maybe with the pos/neg training data image) how it works. alternatively, we can link the paper in the end... but not the most supernice version.. ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment