Make completion feature easier to find
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
Is your feature request related to a problem? Please describe.
We have the redocly completion command to let users add autocomplete to their commands, but it's not well-known so some users don't find it. Let's make it easier for users to discover this existing feature.
Describe the solution you'd like
Add a message after installation telling the user about the command if they want autocomplete.
Describe alternatives you've considered
We talked about automatically installing the autocomplete but that's more difficult and not every user will want that. The existing behaviour is fine, but the purpose of the issue is to make it more findable.
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 tracing the installation flow in the TypeScript CLI and inspect the existing redocly completion command entry point. Add a post-install message that points users to the command for autocomplete, then verify that installation still completes normally and the message is shown in the intended cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100