Extension should have a deeper connection to the documentation

Open
#553 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
developer-experience, documentation

Research direction

Start by mapping how the VS Code extension creates hover documentation for CodeQL elements and how public documentation URLs are identified. Consult the language and documentation teams about URL coverage and expected behavior for all documented elements. Done means each applicable hover exposes a working link to its public documentation.

Written by the indexing model from the issue text.

Description

enhancement VSCode

All CodeQL language and library docs are hosted online. When a user hovers over a particular element in the editor, the hover documentation appears in a public location. This issue is about adding a link to that documentation from inside the hover for all documented code elements.

This will probably require support from the language and documentation teams.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.