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

[💡 FEATURE] - Adding More Documentation #67

Open

mding5692 opened this issue May 22, 2020 · 0 comments · May be fixed by #74

Assignees

Labels

Contributor

mding5692 commented May 22, 2020 •

edited

Adding extra documentation to this repo like mentioned here such as:

SHORTCUTS.md: List of shortcuts and what they map to
Creating a wiki section and redirecting users to that, maybe shortcuts can be on wiki as well
Moving docs or intro to a github pages like here and then move all relevant docs in a /docs folder
Also moving some sections out of README into their own files as README getting bit big or just using a table of contents so easy to navigate README

Definitely a suggestion for when the project is more mature and has more stuff to document

mding5692 added the enhancement label

mding5692 assigned alexkim205

alexkim205 linked a pull request

that will close this issue

Add more documentation #74

Draft

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