NeonGeckoCom / NeonGeckoCom/neon-docs
[FEAT] Document Plugin Configuration
Open
Nobody has claimed this yet.
documentation
enhancement
help wanted
- Dominant language
- No language data
- Stars
- 5
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Objective
Plugin configuration is pretty standard among different plugins; for a section with module, a nested dict under key module is passed to the module init.
Initial Implementation Requirements
- Add a module config note to docs
Other Considerations
This may exist in OVOS docs; if there's a stable link to reference we may just insert that
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 with docs/quick_reference/configuration.md, especially its existing plugin configuration section. Check whether the referenced OVOS documentation has a stable link that explains how a nested module dictionary is passed to module initialization. Done means the configuration note or stable reference is added to the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100