Eddiebot: documentation in the readme is getting large

[AllanRegush]

The documentation in the readme is getting a bit large. Should we move to GitHub wiki or create our own documentation page hosted on GitHub pages?

Join Eddie's discord community here

[github-actions[bot]]

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community :nerd_face:

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

[BOLT04]

yes, I think we should move some docs outside the README, to organize it a bit better. Using the wiki is fine, but perhaps people don't look for it that much 🤔... or maybe just a docs folder with the markdown files.

However we decide to do it, I think it's a good idea 👍

[Vyvy-vi]

This is a great idea 👍
Perhaps we could use a tool to link docs made in a folder with docs on a github Pages site? (something like asciidoc)
(or we could make our own action that updates the github pages source files with data from the docs folder)
hosting on GitHub pages

[stemount]

@Vyvy-vi @BOLT04 @AllanRegush I haven't checked that in a while.

Yes, if we printed this on A4 we would need an entire ream of 500 sheets of paper.

I'd suggest we can totally cut half of the README at this point https://github.com/EddieJaoudeCommunity/EddieBot#standardized-code-formating

[nhcarrigan]

Yes, if we printed this on A4 we would need an entire ream of 500 sheets of paper

This is an exaggeration, right?

[stemount]

Yes, if we printed this on A4 we would need an entire ream of 500 sheets of paper

This is an exaggeration, right?

I've been caught! Yes :-P

[nhcarrigan]

I do think a lot of the README could actually be moved in to the CONTRIBUTING file. IMHO, the README should be how to use the app, where the CONTRIBUTING should be how to contribute.

I'm also in full support of building an actual documentation website - I've done something similar for my own bot.

[Vyvy-vi]

I think the README contained the details since many first-time contributors might not read the CONTRIBUTING file
Though I also think that the README content should be added to the CONTRIBUTING (or alternatively some docs folder)

[nhcarrigan]

Migrating the content to the CONTRIBUTING file and adding the following section to the README would alleviate that.

## Contributing

If you are interested in contributing to this project, please review our [contributing documentation](./CONTRIBUTING.md)

[AllanRegush]

@eddiejaoude could you share your opinion?

[eddiejaoude]

We can move things out of the README if it is getting too big 👍 . But please not the wiki, sorry, I think a docs folder is better because it is more obvious to people and changes can go via a PR.

My thoughts:

1. move relevant docs to the CONTRIBUTING file
2. move more detailed docs that goes into too much info from the README into the docs folder and link to it from the README

[stemount]

@EddieJaoudeCommunity/coreteam yeah, I'm with Eddie on this one, I disagree with github wiki feature as the code should have local documentation.

I generally have a folder structure like this

|- .readme
  \- SOMETHING.md
  \- ANOTHER.md
|- README.md

then I link from README.md, but this is just something I only really enforce on my own projects as it's my personal style, so I'm putting it up for critique and debate.

[nhcarrigan]

I do similar, with a docs folder. With the exception of specific files like CONTRIBUTING.md which go in the root.

[BOLT04]

@stemount is your .readme folder the same has docs? Either way, I agree with Eddie's thoughts 👍

[BOLT04]

@AllanRegush this should have been closed with the PR #401 right? Can we close it?

[AllanRegush]

I think there is more do yet. We should move some parts of the README to contribution.md

[BOLT04]

ahhh true, thanks for reminding me 👍 @AllanRegush
What sections would you say we should move to contributing.md? Maybe Standardized Code Formating, Using Commitizen for commits and logging perhaps?

[eddiejaoude]

Sounds good, the standards used make sense 👍

If too much gets moved, it can always be moved back if needed