Comments (5)
@BOLT04 It was my initial look-in. I was trying to read the code to understand the flow of what was going on. I don't know Typescript, but I am pretty good at reading through code to get a gist of what its doing; especially when it has comments. That's what I was looking for. I like that the scope has been expanded to include a more general documentation of what the bot does. I think that's useful too.
I hope that helps.
from eddiebot.
Help got moved to here https://github.com/EddieJaoudeCommunity/EddieBot/blob/develop/src/commandHandlers/help.ts
It is probably still relevant for all commands. I think you mentioned it too @BOLT04 that we need some docs on how to add a command to the project
from eddiebot.
I think for now, we keep adding to the README
and when it gets too big we will start splitting things out and keep the high level / important stuff in the README
and more details in docs
from eddiebot.
@eddiejaoude is this issue stale and can we close it? I couldn't find the file help.ts
, maybe it was renamed or deleted.
from eddiebot.
Would that documentation go to the README @eddiejaoude ? Or a folder called docs
at the root of the project?
Also @mikeysan, could you elaborate on what your difficulty was when reading the code? Even though the file changed quite a bit, your feedback would help creating the documentation and the comments that are necessary 😃
from eddiebot.
Related Issues (20)
- [FEATURE] Configuration Commands HOT 2
- [request to join the open source community] HOT 2
- [OTHER] migrate custom word checker
- [OTHER] save warnings to database
- [FEAT] Save stats to the DB
- Remove The Word "Just" from moderation HOT 5
- [DOCS] fix typo in README.md
- [FEATURE] Allow the word invalid HOT 2
- [FEATURE] Unblock tinker HOT 1
- [FEATURE] Add Kubescape file
- [FEATURE] <adding master to the list of trigger words> HOT 3
- [FEATURE] <allow the word Black> HOT 3
- {FEATURE REQUEST} Allow the names “The Lion King”& “Women Who Code” HOT 3
- [FEATURE] Improve notifications by context checking
- [OTHER] screenshot in readme
- Please invite me to the Github Community Organization HOT 1
- [FEATURE] <to handle messaging multiple channels in a server>
- [FEATURE] Warn users who upload images without alt text HOT 4
- "Disabled" sensitivity prompt is incorrect HOT 5
- [BUG] Can't find duplicate letter words HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from eddiebot.