Eddiebot: README.md contains information that could be much better handled with Discord FAQ

[stemount]

The eddiebot README.md is full of advice on how to get Discord setup when these could be very tidily presented as a list of links on how to get the Server ID, Channel ID, enable development mode etc.

I however found the documentation too confusing (as the first Discord bot I ever setup) and ended up having to Google it anyway which is not a good sign.

The README should really be streamlined for readability. It assumes you've used Discord before and sort of understand your way round, which is a complex subject.

Does anybody else agree? 💯

[BOLT04]

Yes, maybe we could shorten the README and put links to the topics you said: Server ID, channel ID, etc. I added those images, for example, so people could get a quick glimpse of where to go, but perhaps a link to the full post is enough

[eddiejaoude]

yeah it has grown, which is good, but now probably time to split up into a concise README and then have links to docs/ folder with more information if people need/want it

[UdokaVrede]

Hi @eddiejaoude I'd like to contribute to this. I'm new here and would appreciate a little guide.

[eddiejaoude]

Awesome @UdokaVrede 👍 - we are still deciding where best to put the information.

What are your thoughts looking at our projects? How could we make it easier for new members and people new to open source? We are building a website together too, which will have similar information https://github.com/EddieJaoudeCommunity/EddieJaoudeCommunity.github.io

[UdokaVrede]

@eddiejaoude like @stemount proposed, looking through the readme I think the information there on discord setup could be done elsewhere and the link attached there instead, this would aid easy readability and better understanding for new contributors most especially. Also, for the guide on how to set up discord, I think a step-by-step documentation with both text and pictorial explanations would help for easy setup for any user.
Also, I'd request that you enlighten me on the projects maybe I could get a link to your social channel.

[eddiejaoude]

information there on discord setup could be done elsewhere and the link attached there instead

Sounds good @UdokaVrede 👍 . I dont think it needs to be a big piece of work from the beginning, any tweaks or improvements will add value and can be merged in, then it can be iterated on in new PRs.

I'd request that you enlighten me on the projects maybe I could get a link to your social channel.

Sure, what do you need? We can always move the docs around later if we need between the repos. Which social channels do you need?

[BOLT04]

Hi @UdokaVrede, it's great that you want to work on this. I can assign this issue to you if you want 😃.

If you are new to contributing to open source, have a look at our CONTRIBUTING file for a guide on commit messages. It hasn't been updated in a while 😅, but it should give the gist of our commits (you can look at git history as well). Don't worry about this convention too much if you are not familiar with it, you can still raise a PR and we'll review and merge your contribution 😃.

Also, I'd request that you enlighten me on the projects maybe I could get a link to your social channel.

I'm not sure if I understood correctly your need, but here are some of our open source projects in development that you can contribute to:

• EddieJaoudeCommunity's website - The website for our community and the GitHub organization (HTML and Tailwind CSS)
• EddieBot - This repository is a Discord bot where the user can run some commands like setting their biography, set reminders or get a time in other timezones (Typescript, Node.js, Discord.js library, Firebase)
• EddieBotUI - A dashboard that consumes the data EddieBot writes on the Firebase Firestore database, and displays it on a web interface (JavaScript, React, Firebase). This is still in early development, we are currently trying out CSS frameworks so we can decide, for example, between Bootstrap or Semantic UI React.

If the social channel link you wanted is the Discord server invite, we have this one on the support repository: https://discord.gg/jZQs6Wu

Feel free to ask us for help on any subject, here on the comments or on Discord 👍

[github-actions[bot]]

Stale issue message

[eddiejaoude]

We still need this, I removed the no-issue-activity label

[UdokaVrede]

Hi I was engaged through October with my outreachy contribution for the
December - March phase, What's the plan on this issue please.

On Sun, Nov 1, 2020 at 11:52 AM Eddie Jaoude [e-mail]
wrote:

We still need this, I removed the no-issue-activity label

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/EddieJaoudeCommunity/EddieBot/issues/197#issuecomment-720069266,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/APFTMSFWI7KVNLNEFDQ27ZTSNU4W5ANCNFSM4QIEYRUA
.

[eddiejaoude]

I think a lot has changed since this was created, I will have to re-research what needs doing later this week (unless someone beats me to it)

[UdokaVrede]

I hope I beat you to it.

On Sun, Nov 1, 2020 at 12:32 PM Eddie Jaoude [e-mail]
wrote:

I think a lot has changed since this was created, I will have to
re-research what needs doing later this week (unless someone beats me to it)

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/EddieJaoudeCommunity/EddieBot/issues/197#issuecomment-720074224,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/APFTMSEWK5VHYWBGPJRYDZLSNVBOXANCNFSM4QIEYRUA
.

[eddiejaoude]

Yes please, feel free to make some notes on ideas around this and we can then create more issues for each piece of work 👍

[github-actions[bot]]

Stale issue message

[BOLT04]

The documentation is being worked on in this PR: #401 and the issue #323 could include questions about Discord setup.
I'll remove the no-issue-activity since I think we can still move a lot of the info in the Requirements section, on to questions on the FAQ 😃.

[eddiejaoude]

Thanks @BOLT04 👍