node icon indicating copy to clipboard operation
node copied to clipboard

doc: add 'not recommended' blockquotes

Open avivkeller opened this issue 1 year ago • 9 comments

Fixes: #52743

This PR adds the ability to add a warning blockquote via the following syntax:

> Warning: ...

Which will be rendered as: image

avivkeller avatar May 03 '24 03:05 avivkeller

Review requested:

  • [ ] @nodejs/crypto
  • [ ] @nodejs/nodejs-website
  • [ ] @nodejs/web-infra

nodejs-github-bot avatar May 03 '24 03:05 nodejs-github-bot

While I'm fine with the idea, the white text on the red background is difficult for my eyes to read.

jasnell avatar May 04 '24 16:05 jasnell

While I'm fine with the idea, the white text on the red background is difficult for my eyes to read.

Good to note! What color scheme would you recommend?

avivkeller avatar May 04 '24 16:05 avivkeller

I honestly don't know what to recommend :-/ ...

jasnell avatar May 04 '24 16:05 jasnell

I honestly don't know what to recommend :-/ ...

I'll experiment. Right now it's the same as Stability: 1 blockquotes.

avivkeller avatar May 04 '24 16:05 avivkeller

A border is also possible:

image

avivkeller avatar May 04 '24 17:05 avivkeller

That's a LOT more readable to my eyes.

jasnell avatar May 04 '24 17:05 jasnell

(Request Review) @nodejs/documentation

avivkeller avatar May 08 '24 22:05 avivkeller

I assume I'm a bit out of the loop here, but why are we not sticking with existing concepts such as <strong class="critical"> and maybe restyle that a bit? And if you really want to introduce a custom syntax for blockquotes, why not adopt GitHub's mechanism?

I decided to go with the same syntax that the Stability: ... blockquote use. Instead of using the default critical error (because they can be [a] hard to read, and [b] these aren't critical), I went with a red box.

avivkeller avatar May 09 '24 12:05 avivkeller

True, your right that the the redesign will incorporate a lot of changes, so I'll close this, but I recommend something similar be included in the redesign

avivkeller avatar May 10 '24 23:05 avivkeller

True, your right that the the redesign will incorporate a lot of changes, so I'll close this, but I recommend something similar be included in the redesign

Feel free to go over the Figmas and check if we have something similar like this already, otherwise, feel free to make suggestions :)

ovflowd avatar May 10 '24 23:05 ovflowd

True, your right that the the redesign will incorporate a lot of changes, so I'll close this, but I recommend something similar be included in the redesign

Feel free to go over the Figmas and check if we have something similar like this already, otherwise, feel free to make suggestions :)

Oh! I didn't know we had figmas, I'll take a look!

avivkeller avatar May 10 '24 23:05 avivkeller