Bot-docs: Incorrect Formatting in Deployment Docs

[mdrichardson]

In this section, we have this note that could use a formatting fix:

I would submit the PR myself, but I was the one who submitted the original PR for this and it appears I don't know how to format this correctly. This is what I see in the .md file:

...which looks like it should work, but does not. Note: We should also remove the semicolon at the end of the command

If you could point out where my formatting went wrong for the docs, I'd appreciate it so I don't make the same mistake in future PRs.

[emgrol]

Hi @mdrichardson, it seems like the command wasn't encased in back quotes (` character), so it didn't show up as a code block (described further in detail in this cheatsheet).

I've reformatted that section, you can see the changes in PR 1660.

[mdrichardson]

@emgrol Aha! That wasn't the change that I submitted...No worries. Probably just lost in translation during the merge from public to private repo.

[zxyanliu]

@mdrichardson
FYI, when it's in the Note box, you can use ' ' instead of ``` wrapping your command.

Is this helpful?

[emgrol]

@mdrichardson, @zxyanliu makes a good point, and I think I found the main issue with your note (which I want to keep as you've formatted it since having the copy button with it makes it easier for the reader)

Tips, notes, warnings, etc. need to be on their own line. When I tried building with your snippet I kept getting a warning about there being an invalid string in the first line of the note. So the note should look like this:
> [!NOTE]
> all of the note's content goes here
> and on following lines if need be

You can see PR 1663 to see how I reformatted the note.

[mdrichardson]

@emgrol Makes sense. Good to know!

[emgrol]

Closing this now that the formatting is correct, changes will go live tonight.