feat: auto-generation of the command table #7
Conversation
|
Do we want to talk about this in the contributing guidelines? If so, I feel we need to talk about the assets/image uploads too |
# Conflicts: # .github/CHANGELOG.md
| import { slashCommand, slashCommandStructure, Logger, constantsConfig } from '../../lib'; | ||
|
|
||
| const data = slashCommandStructure({ | ||
| name: 'generate_command_table', |
There was a problem hiding this comment.
Could we make that with - instead of _, it feels more natural as a command
| name: 'generate_command_table', | |
| name: 'generate-command-table', |
There was a problem hiding this comment.
All other commands currently use _. Do we want to refactor all commands?
There was a problem hiding this comment.
All other commands currently use
_. Do we want to refactor all commands?
Thought we discussed to do so? Overall, - is used in natural language and easier to use than _, which requires pressing the SHIFT key, seems minor, but it is a difference; and is not something that appears in natural language.
There was a problem hiding this comment.
Potentially we did - has not happened yet if so!
I can merge this one as is, and I'll go through and refactor all at once in the next PR?
Description
This PR adds a command which automatically generates a Markdown table populated with command data from the Discord API.
It replaces the previous method of filling in our command table documentation manually. Once the command has been merged, deployed and successfully tested, a bot developer, docs team member, moderator or admin can run the
/generate_command_tablecommand, which will generate the table, and upload it to Cloudflare R2 where the FBW docs site can embed it.4 env to be added to DO:
CLOUDFLARE_BUCKET_NAME
CLOUDFLARE_ACCOUNT_ID
CLOUDFLARE_ACCESS_KEY_ID
CLOUDFLARE_SECRET_ACCESS_KEY
This could be added to the schedular to run every 6/12 hours.
Test Results
N/A yet
Discord Username
benw8484