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

Documentation viewer #147522

Closed
digitarald opened this issue Apr 15, 2022 · 2 comments
Closed

Documentation viewer #147522

digitarald opened this issue Apr 15, 2022 · 2 comments
Assignees
Labels
feature-request Request for new features or functionality

Comments

@digitarald
Copy link
Contributor

digitarald commented Apr 15, 2022

image

image

By making finding and reading documentation easier in VS Code we reduce context switching, make continuous learning more integrated, and make documentation more interactive.

Core concepts

  1. Expand the docs shown in API autocomplete to their own space, easier to read and navigate (like Docs View).
  2. Look up concepts, tutorials, and guides that don't fit into API docs.

While the secondary side bar available makes the UX a bit easier, the main challenge of making this easy to discover for users who need it, but unobtrusive for .

Expanding on the core concepts

  • When documentation is open source, show contribution touch points (like the Edit button in VS Code docs).
  • Make source code examples in docs copy-able/interactive/etc with VS Code (including images).
  • Educators can create course material to read, run, and complete within VS Code.
  • API docs for 1st party and dependencies can be generated by language-specific extensions.
  • Extensions could provide endpoints for documentation discovery, like Open Search.

Extensions that provide something similar:

Current state of longer docs in suggestions (default off, enabled via ^Space):

image

  • Limited amount of space and overflowing code examples
  • Over-scrolling the docs glitches with scrolling the editor
@digitarald digitarald added the feature-request Request for new features or functionality label Apr 15, 2022
@digitarald digitarald self-assigned this Apr 15, 2022
@digitarald
Copy link
Contributor Author

@digitarald
Copy link
Contributor Author

Closing as it got few 👍 and https://marketplace.visualstudio.com/items?itemName=bierner.docs-view solves it.

@digitarald digitarald closed this as not planned Won't fix, can't repro, duplicate, stale Jan 3, 2024
@microsoft microsoft locked and limited conversation to collaborators Jun 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

2 participants