mdn / content

The content behind MDN Web Docs
https://developer.mozilla.org
Other
9k stars 22.44k forks source link

Usage of {{AvailableInWorkers}} is not mentioned in writing-guide templates #30710

Open skyclouds2001 opened 7 months ago

skyclouds2001 commented 7 months ago

MDN URL

https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

  1. the Page_types instructors doesn't mention the usage of macros {{AvailableInWorkers}}

including: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_landing_page_template https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_constructor_subpage_template https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_property_subpage_template https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_method_subpage_template https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_event_subpage_template

neither in macros part https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros

~the position to place {{AvailableInWorkers}} macros may need to speificed, as it is under discussion~

it seems that it reached a conclusion that, {{AvailableInWorkers}} should be placed as the top of the article

  1. the usage of {{Compat}} and {{specifications}} is not correct, it is no longer to passing parameters

  2. the {{Interface_Overview}} in fact doesn't existed

What did you expect to see?

add content of the usage of macros {{AvailableInWorkers}}

Do you have any supporting links, references, or citations?

-

Do you have anything more you want to share?

also notice https://github.com/mdn/yari/issues/10009 and https://github.com/mdn/yari/pull/10029, the content may need to reflect the change when they have done

MDN metadata

No response

hamishwillee commented 7 months ago

Have you got a link to the discussion?

Right now the {{AvailableInWorkers}} should be applied to every interface, function, property, method where it applies at the end of the first section (i.e. before Syntax). I think it should also appear in the API overview, but not in Using guides. This is how it has been done so far, and is fairly consistent.

This can be documented now. If it changes, following discussion we can update.

Did you want to take care of this?

skyclouds2001 commented 7 months ago

Have you got a link to the discussion?

Right now the {{AvailableInWorkers}} should be applied to every interface, function, property, method where it applies at the end of the first section (i.e. before Syntax). I think it should also appear in the API overview, but not in Using guides. This is how it has been done so far, and is fairly consistent.

This can be documented now. If it changes, following discussion we can update.

Did you want to take care of this?

I'd love to do this

skyclouds2001 commented 7 months ago

Have you got a link to the discussion?

Right now the {{AvailableInWorkers}} should be applied to every interface, function, property, method where it applies at the end of the first section (i.e. before Syntax). I think it should also appear in the API overview, but not in Using guides. This is how it has been done so far, and is fairly consistent.

This can be documented now. If it changes, following discussion we can update.

Did you want to take care of this?

emmm, currently I did not create a discussion yet

hamishwillee commented 7 months ago

I'd love to do this

That would be great thank you. I wouldn't create a discussion yet. This kind of thing is already being discussed in the bigger context of "all headers".

skyclouds2001 commented 7 months ago

Since https://github.com/mdn/yari/pull/10029 is on working, this could be put afterwards until that work has been done