Repository navigation
docs(basic): added basic docs - #30
Merged
Merged
Conversation
github-project-automation
Bot
moved this from 📥 Inbox / Ideas
to Done
in hexaTune Project
github-actions
Bot
added
default:unclassified
husamettinarabaci
added a commit
that referenced
this pull request
Oct 22, 2025
* feat(setup): added basic at command (#19) Added basic at command implementation. It support usb-midi sysex protocol * feat(setup): setted up pre commit hooks (#20) Added reuse prettier commitlint hook * feat(setup): setted up pre commit hooks (#21) Added reuse prettier commitlint hook 3 * feat(async): setted up async tasks (#23) Added rgb usb at async tasks and channel before firmware update * feat(firmware): added basic firmware update (#24) Added simple bootsel FWUPDATE command to At * feat(com): passed first communication (#25) Communicated with mobile app first time * feat(freq): added basic freq handler (#27) Added simple at freq handler not check and control * feat(core): added multi core (#28) System is configured for working multi-core. DDS task is working on the Core-1 and others on the Core-0 * feat(core): at command is made by id based (#29) Changed all message types to at command base and id forced for all at command * docs(basic): added basic docs Added simple documantation for version v1.0.0 (#30)
husamettinarabaci
added a commit
that referenced
this pull request
Oct 30, 2025
* feat(setup): added basic at command (#19) Added basic at command implementation. It support usb-midi sysex protocol * feat(setup): setted up pre commit hooks (#20) Added reuse prettier commitlint hook * feat(setup): setted up pre commit hooks (#21) Added reuse prettier commitlint hook 3 * feat(async): setted up async tasks (#23) Added rgb usb at async tasks and channel before firmware update * feat(firmware): added basic firmware update (#24) Added simple bootsel FWUPDATE command to At * feat(com): passed first communication (#25) Communicated with mobile app first time * feat(freq): added basic freq handler (#27) Added simple at freq handler not check and control * feat(core): added multi core (#28) System is configured for working multi-core. DDS task is working on the Core-1 and others on the Core-0 * feat(core): at command is made by id based (#29) Changed all message types to at command base and id forced for all at command * docs(basic): added basic docs Added simple documantation for version v1.0.0 (#30) * feat(multicore): fixed multicore Fixed channel for multicore tasks * feat(multicore): fixed multicore Fixed channel for multicore tasks
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
1 participant
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.
Added simple documantation for version v1.0.0
🧩 Affected Module(s)
Mark the modules impacted by this PR:
This pull request introduces comprehensive documentation improvements and reorganization for the hexaGenMini project. The changes provide clearer onboarding, detailed system architecture, and an organized overview of the repository structure, making it easier for new users and contributors to understand and navigate the project.
Documentation Enhancements:
README.mdwith a project introduction, feature list, quick start instructions, AT command protocol, architecture overview, contribution guidelines, and contact information.docs/GETTING_STARTED.md, outlining prerequisites, setup steps, development workflows for firmware, hardware, and mechanical design, and links to further documentation.docs/ARCHITECTURE.md, describing firmware modules, task distribution, AT command structure, error codes, communication protocol, hardware interfaces, and configuration management.docs/PROJECT_STRUCTURE.md, detailing the purpose and contents of each directory and file, including firmware, hardware, mechanical, and documentation components.