arduino / arduino/Arduino

Documentation of libraries in the Editor

Open
#2,692 1 comment 0 reactions 0 assignees View on GitHub
feature request
Dominant language
Java
Stars
14.6k
Forks
7k
PR merge metrics
No merged PRs in 30d

Description

A way to be able to show documentation for also libraries, and improve usability as that documentation appears to the user would be interesting.

Could appear when the user holds CTRL upon the name (as in the image attached).
![espaco de trabalho 1_467](https://cloud.githubusercontent.com/assets/515675/6377242/a3c5a150-bd01-11e4-8967-33b8a6661a36.png)

Or could come along with autocomplete (#849)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Editor's existing handling of library names and the autocomplete work referenced in #849. Compare the proposed CTRL-on-name interaction with showing documentation alongside autocomplete, then clarify the source of library documentation and the expected user-facing behavior before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.