Skip to content

Conversation

dlchamp
Copy link
Contributor

@dlchamp dlchamp commented Aug 16, 2023

Description

Add content to popular-topics/webhooks

Relevant Issues

Closes #61

@dlchamp dlchamp changed the title Feat add webhook page feat: update popular-topics/webhooks Aug 16, 2023
@dlchamp
Copy link
Contributor Author

dlchamp commented Aug 16, 2023

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly.
Please advise if there is a way to make that work.

@abhigyantrips
Copy link
Member

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly. Please advise if there is a way to make that work.

Could you elaborate on what you mean by "list text"? I'm not sure I understand

@dlchamp
Copy link
Contributor Author

dlchamp commented Aug 16, 2023

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly. Please advise if there is a way to make that work.

Could you elaborate on what you mean by "list text"? I'm not sure I understand

The line:

- <DocsLink reference="disnake.Webhook.partial">Webhook.partial()</DocsLink> - Create a Webhook with an `id`, webhook
  `token`, and optional `bot_token`

image

Rather than showing the ` it should convert it to a codeblock around those words.

@shiftinv shiftinv added t: page/section addition Pull Request to add new content to the guide. t: enhancement s: needs review labels Aug 16, 2023
@shiftinv
Copy link
Member

Seems like this happens any time a list item starts with a tag (even just <b>) - not sure why, since it works in the MDX playground, so it might be a docusaurus quirk?

@shiftinv
Copy link
Member

shiftinv commented Aug 16, 2023

Turns out this is a MDX v1 issue, we'd have to update to the Docusaurus v3 alpha to use MDX v2: facebook/docusaurus#8945. I'm not sure if updating is viable for us right now (@abhigyantrips?), especially given that there's only the initial v3 alpha from two months ago.

edit: as a workaround, <code> should work

@abhigyantrips
Copy link
Member

Turns out this is a MDX v1 issue, we'd have to update to the Docusaurus v3 alpha to use MDX v2: facebook/docusaurus#8945. I'm not sure if updating is viable for us right now (@abhigyantrips?), especially given that there's only the initial v3 alpha from two months ago.

edit: as a workaround, <code> should work

Yeah, that's why we haven't updated to v3 yet. I've been looking at showcase sites though, it has been working well in prod.

But yeah I used <code> whenever the issue came up while writing.

Remove a somehow randomly added "{' '}" on line 22
Reworded short descriptions for Webhook.from_url and .partial.
Expanded on the usage of session within the note for the section that needed it.
@dlchamp
Copy link
Contributor Author

dlchamp commented Aug 16, 2023

I didn't like the way it looked, so I just axed it altogether and reworded the lines having that issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
s: needs review t: enhancement t: page/section addition Pull Request to add new content to the guide.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: update popular-topics/webhooks
3 participants