alexkim205 / alexkim205/G-Desktop-Suite

[💡 FEATURE] - Adding More Documentation

Ouverte
#67 0 commentaires 1 réaction 1 personne assignée Réclamée par @alexkim205 Voir sur GitHub
enhancement
Langage dominant
JavaScript
Étoiles
1.6k
Forks
100
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Adding extra documentation to this repo like mentioned [here](https://guides.github.com/features/wikis/) 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](https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/) 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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.