[docs, README] Update READMEs. Add some docs.#13
Merged
AlexLanzano merged 1 commit intowolfSSL:mainfrom Mar 13, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect a reorganized repo structure and to centralize “how-to” guidance in dedicated docs.
Changes:
- Restructures
README.mdto focus on repo layout and “Further reading” links. - Updates
tests/README.mdandexamples/README.mdto reference top-levelboards/and simplify instructions. - Removes the Doxygen configuration file (
Doxyfile).
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| tests/README.md | Clarifies hardware test suite structure and points board details to boards/README.md. |
| examples/README.md | Updates example structure docs to use shared top-level boards/. |
| README.md | Replaces detailed overview with repo layout + links to dedicated docs. |
| Doxyfile | Removes the repository’s Doxygen config file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AlexLanzano
force-pushed
the
docs
branch
2 times, most recently
from
8b112a3 to
454c362
Compare
There was a problem hiding this comment.
Pull request overview
Updates and expands project documentation by simplifying top-level READMEs, adding focused “how-to” guides, and adjusting repository housekeeping to track the new docs/ content.
Changes:
- Refactors
README.md,examples/README.md, andtests/README.mdto point readers to more detailed docs and clarify layout. - Adds new contributor guides under
docs/(driver, board, example, and test how-tos). - Removes the legacy
Doxyfileand updates.gitignoresodocs/is no longer ignored.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/README.md | Reorganizes hardware/core test documentation and clarifies outputs and structure. |
| examples/README.md | Updates example structure doc to reference top-level boards/ support. |
| docs/writing_a_driver.md | Adds a detailed guide for implementing platform drivers and common patterns. |
| docs/adding_an_example.md | Adds step-by-step instructions and templates for creating examples. |
| docs/adding_a_test.md | Adds guidelines/templates for generic vs platform-specific hardware tests. |
| docs/adding_a_board.md | Adds a guide describing required board files and responsibilities. |
| README.md | Simplifies top-level README and links to the new docs pages. |
| Doxyfile | Removes Doxygen configuration from the repo. |
| .gitignore | Stops ignoring docs/, allowing new markdown docs to be committed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+59
to
+67
| OBJECTS = $(patsubst %.c,$(BUILD_DIR)/%.o,$(SOURCE)) | ||
| DEPENDS = $(OBJECTS:.o=.d) | ||
|
|
||
| all: $(BUILD_DIR)/$(notdir $(CURDIR)).bin | ||
|
|
||
| $(BUILD_DIR)/%.o: %.c Makefile | ||
| @mkdir -p $(dir $@) | ||
| $(GCC) $(CFLAGS) -c -o $@ $< | ||
|
|
Comment on lines
+64
to
+66
| $(BUILD_DIR)/%.o: %.c Makefile | ||
| @mkdir -p $(dir $@) | ||
| $(GCC) $(CFLAGS) -c -o $@ $< |
Comment on lines
+24
to
+27
| void main(void) | ||
| { | ||
| if (Board_Init() != WHAL_SUCCESS) | ||
| goto loop; |
This file contains hidden or 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
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.
No description provided.