node-red / node-red/node-red.github.io
Add information on junctions to wire documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 118
- Forks
- 161
- Avg merge
- 8h 18m
- Merged PRs (30d)
- 4
Description
A while ago, I added junctions to some wires. Today, I needed to do it again, and couldn't remember what keys to hold down while dragging. The documentation doesn't mention junctions at all.
Once I found out that they were called junctions (searching for "node red split wire" doesn't produce useful results) I found something in the 3.0 release notes but it took over 10 minutes in all.
Could something be added to the documentation covering this feature? I can submit a PR for the text, but I'm not really in a position to generate helpful images at the moment unless I just lift the ones from the release notes.
Contributor guide
No contributing guide indexed for this repository
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 with the wire documentation page and compare it with the linked Node-RED 3.0 release notes on junctions. Document how to create junctions, including the keys held while dragging, and add helpful imagery if available; the documentation should let users discover and use the feature without searching elsewhere.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100