Skip to content

Contradictions in the docs #8391

Closed
@racz16

Description

@racz16

I found some contradictions in the docs. Could you clarify which information is correct and update the docs accordingly?

keywords field in package.json

The Extension Manifest page of the docs says:

An array of keywords to make it easier to find the extension. These are included with other extension Tags on the Marketplace. This list is currently limited to 5 keywords.

The Publishing Extensions page of the docs says:

The Visual Studio Marketplace does not allow an extension package to have more than 10 keywords in the package.json. Keep the number of keywords/tags to less than 10 to avoid this error.

So, the 1st page says that the limit is 5, the 1st sentence of the 2nd page says that the limit is 10, while the 2nd sentence of the 2nd page implies that the limit is 9. At the same time, some extensions, for example, Prettier clearly have more keywords than any of these limits.

icon field in package.json

The Extension Manifest page of the docs says:

The path to the icon of at least 128x128 pixels (256x256 for Retina screens).

The Publishing Extensions page of the docs says:

Set an icon by specifying a relative path to a 128x128px PNG file included in your extension via the icon property in package.json.

The 1st page says at least 128x128px, and the 2nd page says specifically 128x128px.

Thank you

Metadata

Metadata

Assignees

No one assigned

    Labels

    doc-bugout of date, inaccurate, confusing content

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions