Update and create README files across the repository - #1
Merged
Conversation
Copilot created this pull request from a session on behalf of
simenopsahl
June 21, 2026 05:50
View session
simenopsahl
marked this pull request as ready for review
June 21, 2026 05:51
There was a problem hiding this comment.
Pull request overview
This PR improves repository navigability by expanding existing directory READMEs and adding new ones where missing, with the root README.md linking to all top-level directories.
Changes:
- Updated the root
README.mdto includebluetooth/,common/, andfeatures/sections alongside existing directory links. - Expanded several existing directory READMEs with clearer scope descriptions.
- Added new README files for previously undocumented GUI and feature subdirectories.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds top-level directory sections and short descriptions for easier repo discovery. |
| bluetooth/README.md | Clarifies Bluetooth directory scope (proxy + BLE scanning/tracking) and constraints. |
| common/README.md | Expands description of shared base configuration contents. |
| features/README.md | Introduces a features directory overview and examples of feature categories. |
| board/README.md | Adds more context on what board variant packages cover. |
| board/pins/README.md | Clarifies that this directory holds GPIO/pin assignments by function/interface. |
| board/extension/README.md | Expands explanation of bus/extension configuration coverage. |
| board/module/README.md | Improves and expands module directory description and organization. |
| gui/README.md | Adds a quick “subdirectories” index and clarifies top-level resolution entrypoints. |
| gui/pages/README.md | Notes that pages are implemented with resolution-specific layouts. |
| gui/widgets/README.md | Adds new README describing reusable widget components. |
| gui/themes/README.md | Adds new README describing theme/color configuration scope. |
| gui/styles/README.md | Adds new README describing shared LVGL styling definitions. |
| gui/fonts/README.md | Adds new README describing font assets and glyph/icon mappings. |
| gui/functions/README.md | Adds new README describing interaction/navigation and display control helpers. |
| gui/weather/README.md | Adds new README describing weather-related components/config. |
| gui/img/README.md | Adds new README describing image assets used by the GUI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Expanded existing READMEs with slightly richer descriptions and created READMEs for directories that were missing them. Root README now references all top-level directories.
bluetooth/,common/,features/sections alongside the existingboard/andgui/entriesboard/,board/pins/,board/extension/,board/module/,bluetooth/,common/,gui/,gui/pages/— added a line or two of context about what each directory coversfeatures/,gui/widgets/,gui/themes/,gui/fonts/,gui/styles/,gui/functions/,gui/weather/,gui/img/All descriptions reference categories of content rather than specific files, so they stay accurate as new files are added.