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

Remove all non-installation instructions/info from README #626

Closed
2 tasks done
alyssadai opened this issue Nov 10, 2023 · 0 comments · Fixed by #647
Closed
2 tasks done

Remove all non-installation instructions/info from README #626

alyssadai opened this issue Nov 10, 2023 · 0 comments · Fixed by #647
Assignees
@rmanaem
Labels
documentation Changes only affect the documentation quick fix Minimal planning and/or implementation work required.

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Nov 10, 2023 •
edited by rmanaem
Loading

The README for this repo is one of our most detailed, and given that we now have (and link to) a dedicated docs page https://neurobagel.org/annotation_tool/ containing what is currently a copy of the README info, I think we can:

  • Delete any step-by-step info related to using the tool from the README
  • Keep only a tool summary, key points on usage, and local installation instructions in the README, linking to the officials docs for other info
@alyssadai alyssadai added the documentation Changes only affect the documentation label Nov 10, 2023
@alyssadai alyssadai added the flag:schedule Flag issue that should go on the roadmap or backlog. label Nov 10, 2023
@surchs surchs moved this to Backlog in Neurobagel Nov 13, 2023
@surchs surchs added quick fix Minimal planning and/or implementation work required. and removed flag:schedule Flag issue that should go on the roadmap or backlog. labels Nov 13, 2023
@rmanaem rmanaem moved this from Backlog to Implement - Active in Neurobagel Nov 22, 2023
@rmanaem rmanaem self-assigned this Nov 22, 2023
@rmanaem rmanaem mentioned this issue Nov 22, 2023
Merged
6 tasks
@rmanaem rmanaem moved this from Implement - Active to Implement - Done in Neurobagel Nov 22, 2023
@surchs surchs moved this from Implement - Done to Review - Active in Neurobagel Nov 23, 2023
@github-project-automation github-project-automation bot moved this from Review - Active to Review - Done in Neurobagel Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rmanaem rmanaem

Labels
documentation Changes only affect the documentation quick fix Minimal planning and/or implementation work required.
Projects
Neurobagel
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] Removed non-installation instructions/info from README.md neurobagel/annotation_tool
3 participants
@surchs @alyssadai @rmanaem