Skip to content

Have a page that describes each component in VS Code #1842

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

Closed
octref opened this issue Sep 10, 2018 · 4 comments
Closed

Have a page that describes each component in VS Code #1842

octref opened this issue Sep 10, 2018 · 4 comments
Labels
doc-enhancement suggested addition or improvement extensibility extension author content under /api

Comments

@octref
Copy link
Contributor

octref commented Sep 10, 2018

See microsoft/vscode#58226 (comment). Although this came in as a feedback for extensibility, I think it would help with regular users too.

The page should breakdown VS Code's UI and explain the terms we use for different parts of VS Code.

@octref
Copy link
Contributor Author

octref commented Sep 12, 2018

We already have this page, but it does not go deep enough:

https://code.visualstudio.com/docs/getstarted/userinterface

We should have some more illustration as the top picture:

image

For the 5 views that we have and all the panels that we have.

@ghost
Copy link

ghost commented Sep 12, 2018

I think the problem is with how the current information is presented; headers need to be organized based on context. Why does the "Working with Tabs" header come 4 sections after "Tabs"? Also, the "Indent Guides" is a child header of "Minimap - outline view" -- this doesn't make any sense. Not to mention that with the recent addition of the actual outline view, this label can be misleading.

There's a lot of noise on that page and I think it would benefit from someone putting all the information together in logical hierarchial structure.

For the 5 views that we have and all the panels that we have.

image

So are all panels views? Or are panels separate from views? Because "View: Open view" displays the image above.

@octref
Copy link
Contributor Author

octref commented Sep 12, 2018

I think the problem is with how the current information is presented; headers need to be organized based on context. Why does the "Working with Tabs" header come 4 sections after "Tabs"? Also, the "Indent Guides" is a child header of "Minimap - outline view" -- this doesn't make any sense. Not to mention that with the recent addition of the actual outline view, this label can be misleading.

There's a lot of noise on that page and I think it would benefit from someone putting all the information together in logical hierarchial structure.

@gregvanl can address the issues. I do feel the information can be a bit overwhelming for just getting started.

Per the "View" thing:

  • The first 5 "Views" are what we call "Views" internally
  • The panels share some code with the "Views", but as you are saying, they are really "Panel Views"
  • The rest you are seeing are "Sub Views"
  • I also opened Give better structure to view vscode#58555

@gregvanl gregvanl removed their assignment Oct 14, 2019
@gregvanl gregvanl added the doc-enhancement suggested addition or improvement label Oct 17, 2019
@gregvanl gregvanl added the extensibility extension author content under /api label Nov 13, 2019
@gregvanl
Copy link

Current User Interface page is performing well 85% CSAT. Creating a page for each UI component would be costly to create and maintain (as UI changes). Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement suggested addition or improvement extensibility extension author content under /api
Projects
None yet
Development

No branches or pull requests

2 participants