Summary
This PR contains adding:
Issue template using forms
Feature Template using forms
Update of Pull Request template
All yaml files have been checked by online validator.
Pages are rendered here (for easier review):
Feature Request template
Issue Template
Impact
These templates can help with more accurate issue/PR explanations which can improve handling these contribution and in overall have a positive influence on User experience.
Related links
This PR closed issue #5956
* Create PULL_REQUEST_TEMPLATE.md
Adding first version of PULL_REQUEST_TEMPLATE.md.
The purpose of this template is to improve and simplify writing more accurate Release Notes.
* Update PULL_REQUEST_TEMPLATE.md
Fix typo.
* Update README.MD - "Type: For reference" labels link
Updating a link to issues labeled with "Type: For reference". The old one is not working due to the updates of labels in the past.
This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.
####CONTENTS:
- Getting Started
- Installing
- Boards
- Libraries
- Library Builder
- Tutorials
- ESP-IDF as Component
- OTA Web Update
- makeEspArduino
- Troubleshooting
- Contributing
This PR also changes the README.md.
* Added instructions for installation with boards manager (stolen directly from esp8266)
* changed to production link instead of dev
* Added to main README. Made mods to images as requested.
* Added links for development package
* Moved version images to README.md
* Just a little change for cleaner look
* Cleaned up README.md and boards_manager.md to make installation easier.
* Added instructions for installation with boards manager (stolen directly from esp8266)
* changed to production link instead of dev
* Added to main README. Made mods to images as requested.
* Added links for development package
* DOCUMENTATION: Moved installation instructions to separate page
* Added Fedora to contents table
* Added Issue/Bug Report section to README
* Some minor improvements
* DOCUMENTATION: Rename directory doc to docs
* Also move ISSUE_TEMPLATE.md to docs directory
* DOCUMENTATION: Use current repo's files
* This makes it consistent instead of having few local and few pointing to
espressif/arduino-esp32 by all linking to local files
* DOCUMENTATION: Fix hyperlink to issue/bug template in contents
* DOCUMENTATION: contents: supress platform specific installation instruction
With this step we remove all dependencies, but git. Mac and Linux come
with Python by default, so they will keep using get.py to update the
toolchain and support binaries. Windows users have an "All point and
click" installation option that requires only git and Arduino to be
downloaded.
Fingers crossed :)
- get.exe is clickable and will soon download binary form of esptool,
which will really simplify installation on Windows
- get.py does not require any extra modules on Linux and Mac
- ```pip install requests``` required only on Windows (if not using
get.exe)
- Paths are made relative to the file in order to make the windows
executable clickable.
