Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide "links" from our extension API docs to sample usage #94747

Closed
eamodio opened this issue Apr 9, 2020 · 3 comments
Closed

Provide "links" from our extension API docs to sample usage #94747

eamodio opened this issue Apr 9, 2020 · 3 comments
Assignees
Labels
api extensions Issues concerning extensions feature-request Request for new features or functionality

Comments

@eamodio
Copy link
Contributor

eamodio commented Apr 9, 2020

Refs: #93604

Our Extension API docs, don't provide/link to examples for how they should be use. It would be great if we provided some sort of link between the API docs and our samples.

We do have this Extension Guides Overview page, which kind of provides some of this, but almost in reverse.

Another idea floated by @kieferrm was to use LSIF in product to provide a sort of "find usages" help to the API directly in the editor -- where we might use LSIF snapshots for popular/good examples of OSS extensions using the particular API.

@Tyriar Tyriar assigned eamodio and unassigned octref Aug 26, 2020
@eamodio eamodio added extensions Issues concerning extensions api feature-request Request for new features or functionality labels Nov 4, 2020
@eamodio eamodio added this to the Backlog milestone Nov 4, 2020
@lramos15 lramos15 assigned jrieken and unassigned eamodio Oct 8, 2021
@jrieken jrieken modified the milestones: Backlog, Backlog Candidates Oct 9, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jan 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api extensions Issues concerning extensions feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

4 participants
@eamodio @jrieken @octref and others