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

[Task] Update Readme.md organization to be more clear #405

Closed
Tracked by #403
kmcginnes opened this issue May 17, 2024 · 0 comments · Fixed by #416
Closed
Tracked by #403

[Task] Update Readme.md organization to be more clear #405

kmcginnes opened this issue May 17, 2024 · 0 comments · Fixed by #416

Comments

@kmcginnes
Copy link
Collaborator

kmcginnes commented May 17, 2024 •
edited
Loading

The root Readme.md file has a lot of information in it. It can be a bit overwhelming for a new user who is unfamiliar with a lot of the concepts mentioned in the readme.

We should be able to better organize the document to help guid a user to the right sections for their needs.

Ideas

  • Table of contents at the top
  • Links to additional documentation toward the top

Related Issues
@kmcginnes kmcginnes mentioned this issue May 17, 2024
Closed
2 tasks
@kmcginnes kmcginnes linked a pull request May 22, 2024 that will close this issue
Docker setup documentation #416
Merged
5 tasks
@kmcginnes kmcginnes mentioned this issue May 22, 2024
Merged
5 tasks
@kmcginnes kmcginnes mentioned this issue May 29, 2024
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docker setup documentation kmcginnes/graph-explorer
1 participant
@kmcginnes