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

Create a user-guide/help pages #20

Open
yGuy opened this issue May 2, 2020 · 1 comment
Open

Create a user-guide/help pages #20

yGuy opened this issue May 2, 2020 · 1 comment
Assignees
Labels
Tag: Documentation About CovidGraph Documentation

Comments

@yGuy
Copy link
Member

yGuy commented May 2, 2020

Explain how to work with the tool - how to search, navigate, and select (multiple!) elements, then how to load and remove related items, etc.
Explain how to use the detail panels, etc.
Create screen-casts, screen-shots, and a description.
Include it in the UI!

@yGuy yGuy added the Tag: Help Wanted Extra attention is needed label May 2, 2020
@Jiros Jiros self-assigned this May 11, 2020
@Jiros
Copy link
Contributor

Jiros commented Jun 26, 2020

I've added a draft guidance document and an overview of the interface diagram -
https://github.com/covidgraph/visual-graph-explorer/blob/master/docs/vge-guidance.md

I still need to:

  • Add a link to the most recent data model
  • Identify a few real world examples and either write these up as step by step guides or do a screencast
  • Add more screenshots.

Happy for any feedback or to adjust the terminology I have adopted here to match any other expectations.

@Jiros Jiros assigned yGuy and unassigned Jiros Jun 26, 2020
@Jiros Jiros added Tag: Documentation About CovidGraph Documentation and removed Tag: Help Wanted Extra attention is needed labels Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tag: Documentation About CovidGraph Documentation
Projects
None yet
Development

No branches or pull requests

2 participants