Overhaul pt2: Writing your own application, tooling and guidelines #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
SergioGasquez
commented
May 31, 2023
SergioGasquez
commented
- Updates Writing your own application and tooling chapters
- Adds style guidelines
* docs: Add Rust documentation style guide (cherry picked from commit f7a307a) * Add missing extension to rust-doc-style-quide * Update the Terminology chapter * Add details on using the terms ESP-IDF and esp-idf * Add more terms * Add note on not using italics with Espressif product names * Improve guidelines on where to add link variables * Add guideine to apply monospace to image and container names * Add section on admonitions * Fix markdown formatting issues --------- Co-authored-by: Kirill Chalov <kirill.chalov@espressif.com>
* feat: ✨ Update chapter order * feat: ✨ Add tooling note * feat: ✨ Update pormpts, console outputs and dev container info * chore: 🔥 Remove hello-world chapter * chore: 🔥 Remove hello-world chapter * feat: ✨ Update information to current state of the template * feat: ✨ Update panic outputs * chore: 🔥 Remove hello-world chapter * feat: ✨ Update blinky code * feat: ✨ Update button code * feat: ✨ Update interrupt code * style: 🎨 Remove personal paths * style: 🎨 Use uppercase * feat: ✨ Update esp-idf-template chapter * feat: ✨ Update espflash chapter * feat: ✨ Update tooling intro * feat: ✨ Update VsCode chapter * chore: 🔥 Remove espmonitor * Update src/tooling/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * Update src/writing-your-own-application/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 🎨 Update links * docs: 🎨 List possible ways of creating an app * docs: 📝 Reformat as list of instructions * docs: 📝 Remove unnecesary logs * docs: 📝 Add wokwi vs code section * docs: 🐛 Fix typo * docs: ⚡️ Update esp-template with new prompts * docs: 📝 Improve note about next chapters * docs: 📝 Update undestanding templates chapters * docs: 📝 Update Wokwi documentation * docs: 📝 Move note about cargo generate * docs: 🎨 Format prompt answers * docs: 🐛 Fix custom runner command * docs: 📝 Update espflash section * docs: 📝 Add support tables for simlating and debugging * docs: 📝 Update applications section * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 📝 Add note about generating project with Cargo * docs: 📝 LT suggestions * docs: 📝 Update esp-idf-hal links * docs: 📝 Use listing and expand how to build/run templates+ * docs: 📝 Add link to main.rs section * docs: 📝 Remove next section paragraph * docs: 📝 Be consistent in template projects name * docs: 📝 Update section name * docs: Add comma Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Fix typo Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Clarify custom chips Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 📝 Avoid listing all the supported chips * docs: ⚡️ Update debbuging support table * docs: 📝 Apply LT suggestions * docs: 📝 Apply LT suggestions * docs: ✨ Add no_std book links --------- Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>
f-hollow
reviewed
Jun 2, 2023
Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>
Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>
Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>
Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>
This was referenced Jun 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.