Single source of truth for commands help text #644
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
humphd
requested changes
Jun 1, 2024
Deploying chatcraft-org with
|
| Latest commit: |
1279273
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cd4b175a.console-overthinker-dev.pages.dev |
| Branch Preview URL: | https://amnish04-commands-metadata.console-overthinker-dev.pages.dev |
|
@humphd Not sure why, I've started getting a lint error in a file I did not even change. https://github.com/tarasglek/chatcraft.org/actions/runs/9333938306/job/25691497752?pr=644 Update: I think its related to @tarasglek's latest commit, and #646 should fix it. |
humphd
approved these changes
Jun 2, 2024
sorry, was distracted and forgot to check on first landing and then forgot to land the fixup |
Amnish04
force-pushed
the
amnish04/commands-metadata
branch
from
2740767 to
1279273
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I always felt that the way we manage commands help text documentation could be done better.
Currently, every time we add a new command we have to manually go and add the corresponding documentation to the
Helpcomponent, which many new developers might not even know about.In this PR,
metaDataproperty toChatCraftCommandclass, that takes ahelpTitleandhelpDescriptionas a markdown string.ChatCraftCommandRegistrynow exposes a list of all the supported command objects, that is used to generate the relevant documentation markdown for the commands table (instead of static text)metaDataa mandatory argument inChatCraftCommandconstructor also ensures that if anyone adds a new command in the future, they cannot get away without adding corresponding documentation to it.I did not file an issue prior to this, as I was just experimenting and it turned out to work well.