Kong / Kong/insomnia-docs

WebSocket documentation misleading

Open
#206 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
34
Forks
70
PR merge metrics
No merged PRs in 30d

Description

### Code of Conduct

- [X] I have read and agree to the Insomnia Docs project's [Code of Conduct](https://github.com/Kong/insomnia-docs/blob/main/CODE_OF_CONDUCT.md).

### What article on docs.insomnia.rest is affected?

https://docs.insomnia.rest/insomnia/websockets

### What part(s) of the article would you like to see updated?

"In order to create a new WebSocket request, click on + in the sidebar."
![image](https://github.com/Kong/insomnia-docs/assets/12475567/6ac4bd82-b5e9-4d35-9ced-e5f2407beeb2)
I spent half an hour trying to find a "+" other than the organization + on the left. The circular "+" button in the second left sidebar is extremely small and my eyes weren't looking for an inverted "+".

### Code of Conduct and Community Expectations

- [X] I agree to follow this project's Code of Conduct
- [X] I agree to abide by the Community Expectations

Contributor guide

Open the contributing guide

Research direction

Start with the affected WebSockets article at https://docs.insomnia.rest/insomnia/websockets and review the instruction about clicking "+" in the sidebar. Update the wording so the circular "+" button in the second left sidebar is unambiguous, then verify the article clearly identifies the control used to create a new WebSocket request.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.