Skip to content
This repository has been archived by the owner on Sep 12, 2021. It is now read-only.

Create a more friendly documentation #1

Open
comhad opened this issue May 20, 2021 · 1 comment
Open

Create a more friendly documentation #1

comhad opened this issue May 20, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@comhad
Copy link
Owner

comhad commented May 20, 2021

Better documentation

Right now the only documentation is in the README.md, this isn't ideal as it's not very user friendly, my end goal is for all types of users to use this so it needs to be more user friendly.

Hosting services

There is two hosting services that come to mind currently, the github.io page which hosts the documentation for my discord bots, and readthedocs.org. I think the github.io page would be better as I can write HTML there which will allow me to create a JavaScript app which helps users construct URLs for the app.

Requirements

Before I make anything I need to get feedback on the app and should add another service to the app else the documentation page will be extremely short.

@comhad comhad added the documentation Improvements or additions to documentation label May 20, 2021
@comhad comhad self-assigned this May 20, 2021
@comhad
Copy link
Owner Author

comhad commented May 22, 2021

There is a basic wiki for now, it will be improved and probably used as a base for all the other documentation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant