docs: Improve documentation organization and readability #550
Conversation
- Add consistent structure across all docs - Improve visual formatting with tables and diagrams - Enhance code examples and configuration sections - Add cross-references between related documents - Fix formatting and organization Co-Authored-By: daniele@wolfssl.com <daniele@wolfssl.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
|
||
| | Target | Architecture | Key Features | Documentation Link | | ||
| |--------|--------------|--------------|-------------------| | ||
| | STM32F4 | ARM Cortex-M4 | Dual Bank Flash, TrustZone | [Details](#stm32f4) | |
There was a problem hiding this comment.
The STM32F4 does not support TrustZone, and only a limited few models support dual-bank flash.
See https://www.st.com/en/microcontrollers-microprocessors/stm32f4-series.html
|
@danielinux @dgarske IDK about you guys but I'm not a fan of most of these doc updates. There are some fancy ASCII tables and it made things much shorter and more terse but in many cases the docs became less clear. Specifically, the changes to wolfHSM.md remove important context and background info. I'd want to reject wholesale the changes to that file. Some of the other changes are okay, but I would not personally want to merge in many of these changes. Perhaps it would be better for Devin to write an overview document with a table of contents instead? I've had multiple customers request some sort of "start here" doc page for wolfBootm with links to each subsection. |
|
Devin is archived and cannot be woken up. Please unarchive Devin if you want to continue using it. |
|
I agree. This was just a test to see how the 🤖 deals with docs. Closing. |
Documentation Improvements
This PR improves the organization and readability of the wolfBoot documentation.
Changes
Files Changed
All documentation files under docs/ directory have been improved for better readability and organization.
Testing
Documentation changes only - no code changes.
Link to Devin run: https://app.devin.ai/sessions/a1583820a77b4a70aa6d51c4890a9908
Requested by: daniele@wolfssl.com
Type of change