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

Enrich VS Code Extension API doc comments with gifs/screenshots #125271

Closed
hediet opened this issue Jun 2, 2021 · 3 comments
Closed

Enrich VS Code Extension API doc comments with gifs/screenshots #125271

hediet opened this issue Jun 2, 2021 · 3 comments
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) feature-request Request for new features or functionality

Comments

@hediet
Copy link
Member

hediet commented Jun 2, 2021

JS documentation comments fully support markdown, including images and gifs. VS Code renders them already nicely.

I think it would be nice to include gifs/screenshots in the extension API doc comments to visually communicate what you can do with that API:

recording

These gifs/screenshots should be hosted statically (e.g. on github pages) and all have the same size. Gifs are cool, but I think I would actually prefer simple screenshots (maybe even with red standardized markers to point to stuff) to reduce noise.

@hediet hediet added feature-request Request for new features or functionality extensions-development Issues for developing extensions labels Jun 2, 2021
@jrieken jrieken added *duplicate Issue identified as a duplicate of another issue(s) and removed extensions-development Issues for developing extensions labels Jun 2, 2021
@jrieken
Copy link
Member

jrieken commented Jun 2, 2021

This is a duplicate. Unfortunately, I don't recall the exact issue number nor its title 😳 Anyways, searching for issues with the same labels will likely help you 👉
https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aopen+label%3A"feature-request"

@hediet
Copy link
Member Author

hediet commented Jun 2, 2021

Sorry, I could not find the duplicate either. But #94747 might be related.

@github-actions github-actions bot locked and limited conversation to collaborators Jul 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

3 participants
@jrieken @hediet and others