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: Improve pointing docs #2703

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

caksoylar
Copy link
Contributor

A few miscellaneous tweaks to improve the newly added pointing-related docs:

  • Add missing code fence languages
  • Fix default &msc value in example
  • Refactor hardware integration page so that tabs work fine
    • This made me rewrite the page so that the headers follow a semantic structure, rather than going file by file. This way we can have proper headers that apply for both unibody/split use cases.

Last one was discussed in the 2477 PR review. Feedback welcome on the approach, though I feel this is the best way. (Unfortunately the diff is hard to follow due to many moved chunks, so you might want to review the final page.)

PR check-list

  • Branch has a clean commit history
  • Additional tests are included, if changing behaviors/core code that is testable.
  • Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
  • Pre-commit used to check formatting of files, commit messages, etc.

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Dec 11, 2024
@caksoylar caksoylar requested a review from a team as a code owner December 11, 2024 01:27

The details will depend on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) as opposed to a unibody keyboard or split central part:
Pointing devices are also supported on split peripherals, with some additional configuration using the [input split device](../../config/pointing.md#input-split).
The configuration details will depend on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) as opposed to a unibody keyboard or split central part.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The configuration details will depend on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) as opposed to a unibody keyboard or split central part.
The configuration details will thus vary depending on if you are adding a pointing device to a [split peripheral](../../features/split-keyboards.md#central-and-peripheral-roles) as opposed to a unibody keyboard or split central part.

@@ -1,30 +1,48 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention somewhere in this page that designers can default ZMK_POINTING to y using the .defconfig file?


</Tabs>

);

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the tab selector goes here and the other two tab appearances become invisible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As long as the selections are synced, I think having separate tabs isn't bad. I find it confusing when you select a tab and it affects things way down the page, and you can't switch back without scrolling to the top.

Copy link
Contributor

Choose a reason for hiding this comment

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

How about just moving the first tab with the trick and leaving the second untouched?


Second, the input listener for the central side is added here, but disabled, so that keymaps (which are included for central and peripheral builds) can reference the listener to add input processors without issue.
Copy link
Contributor

Choose a reason for hiding this comment

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

This sentence feels like it needs some rephrasing. Also, for a split keyboard with a pointing device on the central, I think that there might be some issue where the peripheral needs the listener. Don't think that's accounted for in the docs atm.

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.

2 participants