missing documented "Contribution Points"

Open

#5,230 opened on Mar 12, 2022 6 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-bug extensibility

Dominant language: Markdown
Stars: 6.6k
Forks: 5.8k
Avg merge: 11h 43m
Merged PRs (30d): 123

Description

Not all Contribution Points are documented.

If you use the completion items in package.json the following are missing from the doc page:

authentication
codeActions
css.customData
documentation
html.customData
iconFonts
localizations
markdown.markdownItPlugins
markdown.previewScripts
markdown.previewStyles
notebookRenderer
notebooks
remoteHelp
semanticTokenModifiers
semanticTokenScopes
semanticTokenTypes
terminal

css.customData and html.customData have the following text in the description

The file paths are relative to workspace and only workspace folder settings are considered.

But that must be for the settings css.customData and html.customData. For contributes.css.customData and contributes.html.customData it should be relative to extension folder.

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Research direction

Start by comparing the Contribution Points documentation page with the completion items in package.json. Document the listed missing contribution points and correct the css.customData and html.customData path descriptions for extension contributions. Done means all listed entries are documented with accurate descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack: markdown
Domain: documentation
Issue type: Documentation
Difficulty: 3/5
Estimated time: 1-2 days
Activity status: Quiet
Clarity: Mostly clear
Newbie friendliness: 55/100

A short digest of beginner-friendly GitHub issues.