Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added a page on dongles #2525

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nick-Munnich
Copy link
Contributor

@Nick-Munnich Nick-Munnich commented Oct 2, 2024

Added a page on configuring dongles, building on the work that @RasmusKoit did in #2401. The method recommended is personal to each user, but works for both boards and shield based keyboards (requires a board for the dongle, to avoid users messing with flash etc).

Subsumes #2401, closes #2044.

EDIT: I am waiting until #2537 to make some changes.

@Nick-Munnich Nick-Munnich requested a review from a team as a code owner October 2, 2024 08:23
@Nick-Munnich Nick-Munnich added the documentation Improvements or additions to documentation label Oct 2, 2024
Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to add a pointer from split keyboards feature page to here, saying it is also used for creating "dongles".

I think this is well written overall. As a side note, it is a bit too prescriptive for my taste (do this, then do this, rather than explaining how the config works) but given the current complexity of the setup it seems unavoidable, assuming we do want to document how to do it.

docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/dongle.md Outdated Show resolved Hide resolved
@Nick-Munnich
Copy link
Contributor Author

As a side note, it is a bit too prescriptive for my taste (do this, then do this, rather than explaining how the config works) but given the current complexity of the setup it seems unavoidable, assuming we do want to document how to do it.

This was intentional, since we keep getting people asking for help setting up a dongle for their keyboard who have not done the whole shield porting thing. I see the dongle setup as just a highly simplified and prescriptive version of the shield docs. I'll adjust to refer readers to the shield guide a bit stronger if they want to understand any details.

Co-authored-by: rasmuskoit <rasmuskoit@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create BLE-based "Dongle Mode" Documentation
2 participants