Update bot token docs by Yudi · Pull Request #1371 · Tyrrrz/DiscordChatExporter (original) (raw)

@Yudi

Closes #1370

Also added step "5. Click Yes, do it! and authenticate to confirm" to GUI and CLI as users might find it unusual for a popup to request their password/2fa code.

image

@Yudi

@Yudi

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the bot token documentation and related UI text to reflect the new process for resetting a bot token. Key changes include:

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
DiscordChatExporter.Cli/Commands/GuideCommand.cs Updated CLI instructions to match the new token reset flow.
.docs/Troubleshooting.md Updated hyperlink reference for bot accounts.
.docs/Token-and-IDs.md Revised token instructions and updated images accordingly.

Files not reviewed (1)

@Tyrrrz

Thanks for the PR.

Hmm, maybe we shouldn't direct users to reset their token by default, as it may break their other integrations, if they have any.

Can we preface the list of steps that explains that you should've gotten the token when you first created the bot? Otherwise, direct them through the steps to reset it if they forgot.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the bot token documentation to clarify the token reset process in both the CLI guide and the documentation files.

Reviewed Changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 1 comment.

File Description
DiscordChatExporter.Cli/Commands/GuideCommand.cs Updated guide steps to reset the bot token and added an authentication prompt.
.docs/Troubleshooting.md Modified the link for bot accounts to reflect updated documentation.
.docs/Token-and-IDs.md Enhanced instructions for exporting with a bot token, added warning sections, and updated steps.

Files not reviewed (2)

@Yudi

Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com

@Yudi

Well noticed.
New text implies user should've saved the token and makes it explicit the old token will stop working.

@Tyrrrz do you think this order makes sense and that the layout looks good?
"If the token was not saved…" isn't an important notice, so an * shouldn't precede it(?)

image Screenshot 2025-05-03 at 21 29 15


New changes:

GUI:

Previous 625 height

@Yudi

@Tyrrrz

I like the new layout. I would rephrase the first line a bit to highlight a bit more that the user should already have the token:

Token is generated when you create the bot. If you've lost it, follow the steps below to generate a new one:

If the line gets too wide, feel free to insert a line break after the period.

As for the *, I think the way it is in the last screenshot is perfect.

@Yudi

Tyrrrz

Tyrrrz

@Tyrrrz

Thanks! Just some small nit picks and we're done

Yudi and others added 2 commits

May 4, 2025 13:44

@Yudi

@Yudi @Tyrrrz

Co-authored-by: Oleksii Holub 1935960+Tyrrrz@users.noreply.github.com

Tyrrrz

@Tyrrrz

Ah, didn't realize that affected rendering

This file contains hidden or 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

[ Show hidden characters]({{ revealButtonHref }})