Add contributor documentation and clean up stale references#29
Open
frisodebacker wants to merge 1 commit into
Open
Add contributor documentation and clean up stale references#29frisodebacker wants to merge 1 commit into
frisodebacker wants to merge 1 commit into
Conversation
Add CONTRIBUTING.md and DeveloperDocs/ with architecture, documentation system, peripheral guide, and testing reference. Update README.md to surface these resources and reflect the current peripheral set (SPI, TWI). Remove stale references to the deleted generate_avr_tools_device_file.swift from AGENTS.md and README.md. Rename splitTarget to splitTargetLSB in SUPPLEMENTAL_DOCUMENTATION.md to match the actual field name.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation for HALGEN workflows and updates existing references to reflect current generator behavior and supplemental documentation fields.
Changes:
- Adds
CONTRIBUTING.mdand detailed guides underDeveloperDocs/. - Updates README contributor links, generated peripheral list, and sample output tree.
- Renames supplemental documentation references from
splitTargettosplitTargetLSBand removes stale script references.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Surfaces contributor docs and updates peripheral/output documentation. |
docs/SUPPLEMENTAL_DOCUMENTATION.md |
Updates split bitfield key references to splitTargetLSB. |
DeveloperDocs/TESTING_AND_GENERATION.md |
Adds build, generation, testing, and inspection command reference. |
DeveloperDocs/DOCUMENTATION_SYSTEM.md |
Adds supplemental documentation system guide. |
DeveloperDocs/ARCHITECTURE.md |
Adds architecture and generator lifecycle overview. |
DeveloperDocs/ADDING_PERIPHERALS.md |
Adds guide for adding or changing peripheral generators. |
CONTRIBUTING.md |
Adds onboarding workflow and review checklist. |
AGENTS.md |
Removes references to the ATDF model regeneration helper. |
💡 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.
Add CONTRIBUTING.md and DeveloperDocs/ with architecture, documentation system, peripheral guide, and testing reference. Update README.md to surface these resources and reflect the current peripheral set (SPI, TWI). Remove stale references to the deleted generate_avr_tools_device_file.swift from AGENTS.md and README.md. Rename splitTarget to splitTargetLSB in SUPPLEMENTAL_DOCUMENTATION.md to match the actual field name.