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

Create a more friendly documentation #1

@comhad

Description

@comhad

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions