node-red / node-red/node-red.github.io

Simplify function global context example

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
118
Forks
161
Avg merge
8h 18m
Merged PRs (30d)
4

Description

The function global context docs should include a more straightforward example rather than dive straight into using it to require other modules.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the function global context documentation and read the current example that starts with requiring other modules. Add a more straightforward introductory example before it, then verify that the documentation explains the basic usage clearly and retains the existing module example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.