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: Pulled the encoders section of the new shield guide out into its own page #2510

Merged
merged 3 commits into from
Sep 30, 2024

Conversation

Nick-Munnich
Copy link
Contributor

As discussed on Discord. Should make the new shield guide a bit cleaner.

@Nick-Munnich Nick-Munnich requested a review from a team as a code owner September 26, 2024 18:04
@Nick-Munnich Nick-Munnich added the documentation Improvements or additions to documentation label Sep 26, 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.

This section was lacking some clarity with dtsi/overlay, especially for non-splits where the former doesn't exist. I tried to fix it while we are at it, any more improvements are welcome.

docs/docs/features/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
docs/docs/development/hardware-integration/encoders.md Outdated Show resolved Hide resolved
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
@Nick-Munnich
Copy link
Contributor Author

Agree with and made all the suggested changes. I read through it again, not sure if there are any easy further improvements. Probably need to see what sort of help requests appear to know what to improve.

@caksoylar caksoylar merged commit a314128 into zmkfirmware:main Sep 30, 2024
7 checks passed
rafaelromao pushed a commit to rafaelromao/zmk that referenced this pull request Oct 8, 2024
…e#2510)


Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
lammai pushed a commit to lammai/zmk that referenced this pull request Oct 27, 2024
…e#2510)


Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
EnotionZ pushed a commit to EnotionZ/zmk that referenced this pull request Nov 6, 2024
…e#2510)


Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
earwin pushed a commit to earwin/zmk that referenced this pull request Nov 13, 2024
…e#2510)


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.

2 participants