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.

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

Improove the readability of all README.md's [1/13 Done] #24

Open
1 of 7 tasks
BlackWolfWoof opened this issue Jul 14, 2021 · 11 comments
Open
1 of 7 tasks

Improove the readability of all README.md's [1/13 Done] #24

BlackWolfWoof opened this issue Jul 14, 2021 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BlackWolfWoof
Copy link
Owner

BlackWolfWoof commented Jul 14, 2021

Not everyone is a pro

People have struggled in the past to understand how to add custom commands to their servers from repositories & how to set them up right.
In the last few weeks or months a few volunteers have created https://yagpdb-cc.github.io/ which makes it a lot easier to see how to add the custom commands to the server and what you have to take a look at when adding them.
I think it would be a good addition to create some kind of template every custom command in the README.md of the subfolders, so everyone knows what to look out for & how to set it up if they add it to their server.

A template for every custom command

  • Finish all pending work so i can focus on this change
  • Create a template with options like 'trigger'
  • Add 'trigger type' to the list
  • Add 'configurable variables' to the list
  • An image showing the custom command in action
  • Issues & disclaimers

For the main README.md

  • A section that explains how to add custom commands from my repository to the server
@BlackWolfWoof BlackWolfWoof added the documentation Improvements or additions to documentation label Jul 14, 2021
@BlackWolfWoof BlackWolfWoof self-assigned this Jul 14, 2021
@BlackWolfWoof BlackWolfWoof pinned this issue Jul 14, 2021
@sinarck
Copy link
Contributor

sinarck commented Jul 14, 2021

Maybe a little guide on how to use github as well.. When I first got here (on github, i mean) it was strange, and hard to figure out what to do and where to go. A little basic guide like, "click the folder here that says Misc," and then where to go, and what to click once you know what you want. Hope this helps

@BlackWolfWoof
Copy link
Owner Author

Maybe a little guide on how to use github as well.. When I first got here (on github, i mean) it was strange, and hard to figure out what to do and where to go. A little basic guide like, "click the folder here that says Misc," and then where to go, and what to click once you know what you want. Hope this helps

Yea, imma do a video & text tutorial just to make sure everyone understands it and so i can reeee at people who don't :)

@l-zeuch
Copy link
Contributor

l-zeuch commented Jul 14, 2021

video/gif adds too much overhead when loading the page.
text should/has to suffice.

@BlackWolfWoof
Copy link
Owner Author

video/gif adds too much overhead when loading the page.
text should/has to suffice.

Embedded videos exist that only load when clicking them :pQuack:, great technology, i know

@l-zeuch
Copy link
Contributor

l-zeuch commented Jul 14, 2021

the media still has to be pre-loaded : )

@BlackWolfWoof
Copy link
Owner Author

BlackWolfWoof commented Jul 14, 2021

Ur mum has to be preload

@l-zeuch
Copy link
Contributor

l-zeuch commented Jul 14, 2021

This is not Discord my guy. A little less rudeness could help.

@BlackWolfWoof
Copy link
Owner Author

Imma add a video anyways shrugs
I have it planned so imma do it

@l-zeuch
Copy link
Contributor

l-zeuch commented Jul 14, 2021

You do you, all I'm saying is that it will inevitably add a lot of overhead when loading in the page.

You should consider putting the media in a folder within the repository, rather than hosting it externally, like /assets or similar.

@BlackWolfWoof
Copy link
Owner Author

BlackWolfWoof commented Jul 14, 2021

As long as it isn't as bad as without this Screenshot_20210714-214304.jpg

BlackWolfWoof pushed a commit that referenced this issue Jul 16, 2021
This is related to the #24 stuff
BlackWolfWoof pushed a commit that referenced this issue Jul 16, 2021
BlackWolfWoof pushed a commit that referenced this issue Jul 16, 2021
@BlackWolfWoof BlackWolfWoof changed the title Improove the readability of all README.md's Improove the readability of all README.md's [8,3% Done] Jul 16, 2021
@BlackWolfWoof BlackWolfWoof changed the title Improove the readability of all README.md's [8,3% Done] Improove the readability of all README.md's [1/13 Done] Jul 16, 2021
@BlackWolfWoof
Copy link
Owner Author

Gonna have to redo this again as I do not like the design

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

No branches or pull requests

3 participants