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

feat(docs): Add a split keyboards feature page #2406

Merged
merged 4 commits into from
Aug 8, 2024

Conversation

caksoylar
Copy link
Contributor

This is an explainer page to describe how split keyboards work in ZMK, with specific details on flashing, pairing, split communications and behaviors with locality. Fixes #948.

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Aug 5, 2024
@caksoylar caksoylar requested a review from a team as a code owner August 5, 2024 06:01
Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

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

LGTM overall, just some minor touchups where I think things could be phrased differently or be made more precise. Feel free to discard most of them if you don't agree with them. There were some parts where I didn't make phrasing suggestions because I thought they might change due to other comments, so I left them for later.

docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/sidebars.js Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

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

I'm happy with this as-is, barring the part/piece/node bit.

@Nick-Munnich
Copy link
Contributor

Oh, just remembered a point: Another note on the battery lives of the central and peripherals would be good somewhere.

@caksoylar
Copy link
Contributor Author

Oh, just remembered a point: Another note on the battery lives of the central and peripherals would be good somewhere.

You are right, I'll add a note for that as well, under central/peripheral roles section.

Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

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

Minor phrasing suggestions now that we have decided on "Part".

docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
docs/docs/features/split-keyboards.md Outdated Show resolved Hide resolved
@Nick-Munnich
Copy link
Contributor

Also a note that this closes #550 as obsolete.

@caksoylar caksoylar merged commit 2eff266 into zmkfirmware:main Aug 8, 2024
7 checks passed
@caksoylar caksoylar deleted the docs/split-feature branch August 8, 2024 06:58
This pull request was closed.
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.

docs: Add a feature page on split boards/shields
2 participants