posit-dev / posit-dev/positron

Add an input to the help pane to look up a help topic

Open
#422 6 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: help
Dominant language
TypeScript
Stars
4.3k
Forks
184
Avg merge
1d 9h
Merged PRs (30d)
195

Description

R Studio's help pane has a search input box that allows the user to look up a help topic. We should add the same capability to Positron.

The search term should be sent to the help comm channel of the active language runtime.

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.

Research direction

Start by locating the help pane implementation and the help communication channel for the active language runtime. Add a search input that sends its term through that channel, and verify that a help topic can be looked up from the pane.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.