docs: Improve documentation for new users #85

neolectron · 2023-09-14T01:56:36Z

List all default features availables.
Explain core concepts of the bot in README.
Complete contributing guide ! - Missing features environments Blocked by feat: make modules isolated using creation function #81
Document module API - WIP (wiki ?).
Reduce the minimal setup required to dev the bot. - Blocked by Reduce the friction for new dev to make a contribution #84

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Peïo Thibault <[email protected]>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Peïo Thibault <[email protected]>

Co-authored-by: Yanzi-dev <[email protected]> Co-authored-by: Manuel <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: Peïo Thibault <[email protected]>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: Peïo Thibault <[email protected]> Co-authored-by: Manu <[email protected]>

Co-authored-by: Manu <[email protected]> Co-authored-by: Manuel <[email protected]>

Co-authored-by: Manu <[email protected]>

Co-authored-by: LazyRabbit <[email protected]>

Co-authored-by: Peïo Thibault <[email protected]>

Alexandre-Chs · 2023-10-26T09:42:37Z

CONTRIBUTING.md

+
+### Minimal setup
+
+Copy [`.env.example`](./.env.example) to `.env` and fill you discord token.


when i git clone, .env.example already exist.
Just need to rename .env.example to .env and fill the discord token.

Alexandre-Chs · 2023-10-26T09:42:58Z

CONTRIBUTING.md

@@ -4,23 +4,43 @@

 We use [pnpm](https://pnpm.io) to manage our dependencies.  
 You can [install it](https://pnpm.io/installation) using your preferred
-method, but we recommend using [Corepack](https://nodejs.org/api/corepack.html#supported-package-managers) so that you
-keep your package manager version in sync with ours.
+method, but we recommend using [Corepack](https://nodejs.org/api/corepack.html#supported-package-managers) so that you keep your package manager version in sync with ours.

 Make sure you run **Node 20** or the dependencies' installation will fail.  
 We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage your Node version.


For windows's user : https://www.freecodecamp.org/news/nvm-for-windows-how-to-download-and-install-node-version-manager-in-windows-10/

Alexandre-Chs · 2023-10-26T09:45:49Z

CONTRIBUTING.md

@@ -4,23 +4,43 @@

 We use [pnpm](https://pnpm.io) to manage our dependencies.  
 You can [install it](https://pnpm.io/installation) using your preferred
-method, but we recommend using [Corepack](https://nodejs.org/api/corepack.html#supported-package-managers) so that you
-keep your package manager version in sync with ours.
+method, but we recommend using [Corepack](https://nodejs.org/api/corepack.html#supported-package-managers) so that you keep your package manager version in sync with ours.

 Make sure you run **Node 20** or the dependencies' installation will fail.  


we must use node 20.8.1.
Latest version of node don't work.

potb and others added 30 commits May 18, 2023 02:31

feat: add voice-on-demand functionality (#2)

6e1ad1b

chore(deps): update all dependencies (#3)

29da9a6

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

refactor(handlers): move conditional logic into handler files (#4)

14b2a0f

chore(deps): update all dependencies (#6)

6077dd1

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

ci: make deployment use the production environment (#7)

f32fb8b

chore: remove unused dependency

ea336aa

chore(deps): update all dependencies (#9)

28491b6

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update dependency type-fest to v3 (#8)

fd38396

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Peïo Thibault <[email protected]>

chore(deps): update all dependencies (#10)

09fc4ca

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update all dependencies (#11)

9774856

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update dependency tsup to v7 (#13)

34ced5d

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update all dependencies (#12)

c4601e1

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update all dependencies (#14)

a98f838

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update all dependencies (#15)

325427c

chore(deps): update all dependencies (#16)

84e5ba9

chore(deps): update all dependencies (#17)

3653452

chore(deps): update all dependencies (major) (#18)

d38e2dd

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Peïo Thibault <[email protected]>

chore(deps): update dependency eslint to v8.45.0 (#19)

bae02d5

feat: replace twitter links with vxtwitter alternative (#5)

98dcf28

fix: better url mapping vxtwitter (#23)

4e5c806

chore(deps): update all dependencies (#24)

03e5dd4

Co-authored-by: Yanzi-dev <[email protected]> Co-authored-by: Manuel <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update dependency type-fest to v4 (#25)

96ee37e

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

feat: add 'fart' slash command (#26)

97337fa

Co-authored-by: Peïo Thibault <[email protected]>

feat: cool links voting system and autothread (#27)

5917f5e

test: add tests to the project (#20)

ff6742f

chore(deps): update all dependencies (#32)

770a659

chore(deps): update dependency eslint-config-prettier to v9 (#33)

4b591b3

chore(deps): update all dependencies (#37)

f341bec

feat: summarize cool links youtube videos (#40)

c5ada12

chore(deps): update all dependencies (#39)

52fd67c

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

luca-montaigut and others added 23 commits September 4, 2023 22:10

feat: quoi feur (#52)

211801d

Co-authored-by: Peïo Thibault <[email protected]> Co-authored-by: Manu <[email protected]>

feat: allow modules to export intents (#55)

79fb2e9

feat: manage recurring messages (#53)

9b647eb

fix: add intents to recurring message (#60)

a2eea82

fix: muted on quoi-feur feature (#61)

58ccddd

fix: remove cache entries on delete channel (#62)

088f6f6

fix: change removeEmoji regex to include custom emojis (#63)

7713504

feat: better display for recurring messages list (#64)

6fa4019

Co-authored-by: Manu <[email protected]> Co-authored-by: Manuel <[email protected]>

fix: remove width hack (#66)

0ba058f

fix: adjust coubeh probability (#65)

f5dbfcf

Co-authored-by: Manu <[email protected]>

feat: add ephemeral to bot message (#67)

2ceed7c

chore(deps): update all dependencies (#70)

b1d395a

chore(deps): update actions/checkout action to v4 (#71)

b221abb

fix: remove useless env variables (#72)

973161b

fix: wrong names of the handlers of quoifeur module (#74)

ceb5709

fix: use the quoifeurbot in public thread of allowed channels (#73)

17c107d

Co-authored-by: LazyRabbit <[email protected]>

chore(lint): use rule to disable usage of devDeps (#76)

9ec51b3

fix: voice lobby now handles multiple guilds (#77)

cfe2416

fix(quoi-feur): check if the trigger word is formatted in md (#68)

2a57c49

Co-authored-by: Peïo Thibault <[email protected]>

fix: remove audio channel when last member leaves (#79)

f25b530

fix(voice-on-demand): check old state when leaving

ceaea24

ci: remove duplicated pipeline actions (#83)

26c3cb3

docs: list features + precise contributing setup

c47faa1

neolectron added the blocked blocked by another PR label Sep 14, 2023

neolectron added 2 commits September 14, 2023 03:57

style: fix typo

8129353

chore: add summary

90a5f5b

Alexandre-Chs reviewed Oct 26, 2023

View reviewed changes

potb force-pushed the master branch 2 times, most recently from c69e2ce to a754471 Compare January 5, 2024 12:13

potb force-pushed the master branch from 154e017 to cf4a36b Compare February 17, 2024 14:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Improve documentation for new users #85

docs: Improve documentation for new users #85

neolectron commented Sep 14, 2023 •

edited

Loading

Alexandre-Chs Oct 26, 2023

Alexandre-Chs Oct 26, 2023

Alexandre-Chs Oct 26, 2023


		### Minimal setup

		Copy [`.env.example`](./.env.example) to `.env` and fill you discord token.

docs: Improve documentation for new users #85

Are you sure you want to change the base?

docs: Improve documentation for new users #85

Conversation

neolectron commented Sep 14, 2023 • edited Loading

Alexandre-Chs Oct 26, 2023

Choose a reason for hiding this comment

Alexandre-Chs Oct 26, 2023

Choose a reason for hiding this comment

Alexandre-Chs Oct 26, 2023

Choose a reason for hiding this comment

neolectron commented Sep 14, 2023 •

edited

Loading