esphome / esphome/feature-requests

README file under esphome/scripts folder

Open
#3,184 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
450
Forks
29
PR merge metrics
No merged PRs in 30d

Description

**Describe the problem you have/What new integration you would like**

The scripts in esphome/scripts are crucial for contributing developers but difficult to understand, I think a README in that folder would be beneficial and could be picked up and autosynched into https://developers.esphome.io/

**Please describe your use case for this integration and alternatives you've tried:**

Have enough understanding of all the esphome/scripts to use them to facilitate development and contributing to ESPHome

**Additional context**

Nice to Have

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the esphome/scripts folder and the developer documentation at developers.esphome.io to understand the scripts that need coverage and how documentation is synchronized. Done means adding a README under esphome/scripts that gives contributing developers enough context to use the scripts and can be picked up by the documentation site.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.