FoxxMD
4abe8e07f3
docs: Add docs for MHS toxic content prediction rule
2022-09-20 10:44:08 -04:00
FoxxMD
44f9389b69
docs: Add general subreddit/moderator docs readme
...
* Also add Guest Access docs
2022-09-16 16:40:28 -04:00
FoxxMD
71b2d0597d
docs: Update screenshots
2022-09-16 15:38:52 -04:00
FoxxMD
fa450f9f8f
docs(database): Add influx/grafana documentation
2022-07-11 13:46:27 -04:00
FoxxMD
1e76ca6c0e
docs(config): Add partial configuration documentation
2022-07-11 13:01:40 -04:00
FoxxMD
9080c7bdf4
Some more docs additions for subreddit state
2022-05-12 12:27:18 -04:00
FoxxMD
ff2415b024
docs: Add more links to main readme
2022-04-27 10:15:40 -04:00
FoxxMD
cf553cad59
docs: Re-organize docs structure and cleanup main readme
2022-04-27 10:09:13 -04:00
FoxxMD
344dcc9879
refactor: New docs for subreddit configurations
...
More features documented with better examples. Not done yet...
2022-04-26 15:54:20 -04:00
FoxxMD
bfc7f8a508
docs: Rewrite and improve operator-related documentation
...
* Break out documentation into more standalone docs and reorganize into an operator folder
* Remove outdated information on adding bot
* Add additional information on docker install
* Make configuration more opinionated for "recommend" approach
* Add docs on database and caching
* Rewrite operator getting started guide to be more concise
2022-04-22 15:24:56 -04:00
FoxxMD
85b1d13718
docs: Refactor docs to use runs syntax
...
* Add Runs to main docs readme and concepts
* Add high level diagram in main docs readme to show CM lifecycle
* Refactor subreddit/rule examples to use runs syntax
2022-03-07 10:28:48 -05:00
FoxxMD
174d832ab0
docs: Pretty up readme header
2022-01-18 16:08:40 -05:00
FoxxMD
dec72f95c6
docs: Add discord invite link
2022-01-14 16:42:01 -05:00
FoxxMD
b32c4f213c
docs(yaml): Finish adding yaml examples
...
#61
2021-12-25 16:42:44 -05:00
FoxxMD
0d087521a7
feat(docs): Specify yaml can be validated in editor
2021-12-21 09:35:06 -05:00
FoxxMD
0c31bdf25e
refactor(repost): Improve repost criteria configuration and add documentation
...
* Simplify usage b/w comment-submission by removing "criteria" in main criteria property -- comment checks can just use additional properties
* Consolidated occurrence count/time into one property to allow and/or operands on both conditions (more powerful!)
* Added documentation describing repost configuration
* Added repost configuration examples
2021-12-07 16:30:05 -05:00
FoxxMD
2c797e0b9b
docs(image): Add documentation for image comparison
...
#26
2021-10-12 11:10:14 -04:00
FoxxMD
2fd1ffed19
Rewrite docs to explain server-client architecture
2021-08-20 13:47:55 -04:00
FoxxMD
7b00e1c54b
Add more screenshots and information to web ui section
2021-08-20 12:11:36 -04:00
FoxxMD
79a518edbc
Move the getting started section up so its more visible
2021-07-30 10:06:09 -04:00
FoxxMD
38507c8990
Fix anchor
2021-07-29 15:21:13 -04:00
FoxxMD
136098354b
Improve getting started documentation #14
2021-07-29 15:19:56 -04:00
FoxxMD
7175965e3d
Update missed naming changes
2021-07-29 11:26:26 -04:00
FoxxMD
44c8bd9a6a
Rebrand to conform to reddit 3rd party app naming guidelines
...
They don't like having reddit as part of the name unless its "for reddit" -- so just remove reddit from name altogether and also drop "bot" as its superfluous. Shorter name is better anyway
2021-07-29 10:50:58 -04:00
FoxxMD
254d2ca896
Add local install requirements
2021-07-28 15:37:44 -04:00
FoxxMD
0afd87ab1b
Doc improvements
...
* Reorganize some main readme contents into separate docs
* Add full bot authentication guide
* Add screenshots and web interface section
Some link fixes and clarifications
Fix another link
Fix another link
More doc cleanup
More doc cleanup
More doc cleanup
Add link to docs in main readme summary
2021-07-28 13:47:24 -04:00
FoxxMD
802884f686
Add operator configuration documentation
2021-07-26 17:06:02 -04:00
FoxxMD
cc2518d086
Refactor documentation and ENHANCE
2021-07-07 13:06:51 -04:00
FoxxMD
79b82dab0f
Refactor footer to be configurable at subreddit and Action level
2021-06-17 14:43:22 -04:00
FoxxMD
879807390d
Add YAML as configuration language to readme
2021-06-16 21:30:43 -04:00
FoxxMD
db0440356c
Refactor author usage to be more universal and change name to match item behavior
...
* (BC) rename authors to authorIs to match itemIs -- since they have the same behavior
* Add author filter to Check so it matches usage of itemIs
2021-06-15 16:12:06 -04:00
FoxxMD
016952128c
Update documentation for Toolbox User Notes
2021-06-15 15:31:59 -04:00
FoxxMD
eb62e39975
Add unmoderated run command
2021-06-14 10:26:05 -04:00
FoxxMD
774b41c2a3
Add readmes for all sections
2021-06-11 19:12:11 -04:00
FoxxMD
48ea60f886
Move heartbeat to app-level config
2021-06-11 14:15:54 -04:00
FoxxMD
1897d96a8f
Add dryrun setting to help with testing
...
Can be configured at action, check, subreddit, or app level
2021-06-11 12:38:01 -04:00
FoxxMD
788af401b3
Support JSON5 for parsing configuration
2021-06-10 13:20:11 -04:00
FoxxMD
6bc74b383f
Implement resource caching
...
User-configurable global/subreddit-level caching for author activities, wiki pages, and author checks
2021-06-10 13:13:57 -04:00
FoxxMD
318a1d3326
Set heroku url to default branch
2021-06-08 16:16:58 -04:00
FoxxMD
72ed72ce4a
Add heroku quick deploy button
2021-06-08 16:07:53 -04:00
FoxxMD
78aed4321a
Add support for reddit permalink when running check command
2021-06-08 13:55:03 -04:00
FoxxMD
5905c910b0
Implement name references for actions and rules
...
Action/Rule objects they can now be referenced by name from anywhere in the configuration
2021-06-08 12:40:00 -04:00
FoxxMD
7960423678
Fix missing bold format character
2021-06-07 14:09:11 -04:00
FoxxMD
4ddb0f0963
Update readme with new cli syntax
2021-06-07 13:58:16 -04:00
FoxxMD
51fb942d34
Fix collapse formatting
2021-06-04 14:04:26 -04:00
FoxxMD
2433610c7f
Add documentation on templating
2021-06-04 13:59:44 -04:00
FoxxMD
473e4b7684
Update readme
...
* Add wikiConfig env
* Collapse for config example
* Config example showcases templating
2021-06-04 13:20:36 -04:00
FoxxMD
3cbc1cb095
Add usage, option definitions, and how-to for getting credentials
...
Closes #6
2021-06-03 16:16:21 -04:00
FoxxMD
c9c9e68250
Better schema documentation in readme
2021-06-03 15:25:54 -04:00
FoxxMD
b7da84d4fc
Add direct link to schema viewer
2021-06-03 15:22:39 -04:00
