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

Intro to Extension Capabilities / Theming topic too complex #2150

Closed
gregvanl opened this issue Nov 1, 2018 · 3 comments
Closed

Intro to Extension Capabilities / Theming topic too complex #2150

gregvanl opened this issue Nov 1, 2018 · 3 comments
Assignees
Labels
extensibility extension author content under /api
Milestone

Comments

@gregvanl
Copy link

gregvanl commented Nov 1, 2018

Testing microsoft/vscode#62108 scenario 1

The first sentence has several unexplained references to Component Identifier and Text Token Identifier.
"A mapping from both UI Component Identifier and Text Token Identifier to colors. "
The implementation details should be later once the user decides this is the extension point they are interested in.

Above the fold image is too small and complex and shows unexplained token visualizer.

There is no mention of the customizations settings which may satisfy most users.

I think the existing Themes content https://code.visualstudio.com/docs/extensions/themes-snippets-colorizers#_adding-a-new-color-theme does a better job of bringing the user up to speed.

In less than one minute, I could change the color of JavaScript keywords and generate a theme with the existing documentation.

@octref
Copy link
Contributor

octref commented Nov 2, 2018

"A mapping from both UI Component Identifier and Text Token Identifier to colors. "

The below sentence immediately explains it: Color theme allows you to apply your favorite colors to both VS Code UI Components and the text in the editor.

Above the fold image is too small and complex and

I can make the images larger, but I think it illustrates what could be a whole page.

shows unexplained token visualizer.

Here is the text right above it: If you want to change the color of text in your editor, you need to know how the text is tokenized. VS Code provides a handy command Developer: Inspect TM Scopes that shows you the TextMate scopes of each syntax token in the editor.

I think the existing Themes content https://code.visualstudio.com/docs/extensions/themes-snippets-colorizers#_adding-a-new-color-theme does a better job of bringing the user up to speed.

The point of the Extension Capabilities is to guide user to the right place, not to dive into details. The content of the original guide belongs to https://vscode-ext-docs.azurewebsites.net/api/extension-guides/color-theme.

Once the Color Theme guide is complete, I'll point it from the Extension Capabilities / Theming topic.

In less than one minute, I could change the color of JavaScript keywords and generate a theme with the existing documentation.

Are we looking at the same page?
image

@octref octref closed this as completed Nov 2, 2018
@octref
Copy link
Contributor

octref commented Nov 2, 2018

However, I do agree that some complex content should go into https://vscode-ext-docs.azurewebsites.net/api/extension-guides/color-theme.

Nobody is writing that guide, guess I have to do it...

@octref octref reopened this Nov 2, 2018
@octref octref added this to the October 2018 milestone Nov 2, 2018
@gregvanl gregvanl added the extensibility extension author content under /api label Nov 2, 2018
@octref octref modified the milestones: October 2018, November 2018 Nov 9, 2018
@octref
Copy link
Contributor

octref commented Nov 19, 2018

@octref octref closed this as completed Nov 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extensibility extension author content under /api
Projects
None yet
Development

No branches or pull requests

2 participants