[docs-infra] IntelliSense (quick info) on code previews
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Summary
We could make it possible, like in VS Code, for developers to have access to quick info on our docs editors.
Examples
Reference points:
It can be tested on https://ariakit.org/guide/getting-started.
- Nuxt, Another one in the same line of thought: https://nuxt.com/docs/getting-started/seo-meta
https://github.com/mui/material-ui/assets/3165635/48fdd88a-d516-41a6-9c64-92d1183ee0ae
But poor execution, it's better UX without it.
- VS Code, it feels like approaching this like VS Code could be a great UX, e.g.
Motivation
No response
Search keywords: IntelliSense quick info
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the docs editors and code previews with the Ariakit, Nuxt, and VS Code reference examples linked in the issue. Define the quick-info behavior and UX for the docs editors; the work is done when developers can access useful IntelliSense-style information in code previews.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100