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.

Sign up for GitHub

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

Jump to bottom

Revamp Community Layouts documentation #23383

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

Revamp Community Layouts documentation #23383

wants to merge 3 commits into from
+97 −81

Conversation

dunk2k
Copy link
Contributor

@dunk2k dunk2k commented Mar 31, 2024 •
edited

Description

  • Modernise from <keyboard>.h and rules.mk files to *.json
  • Language overhaul to accommodate the QMK beginner/novice
  • specify imperatives of this feature

QMK Maintainer Input

  • Should a section regarding addition of Community Layouts be added?
    • This would include loose and/or strict naming convention(s)
  • Is format up to par with other docs?
  • Does contents flow?
  • Does this documentation answer more questions than it creates?
  • Should the mention of Miryoku be removed?
  • Should the mention of Userspace feature be removed?
  • Include make command equivalents for qmk compile commands?

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

  • n/a

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@dunk2k dunk2k marked this pull request as ready for review April 1, 2024 15:50
@dunk2k
Update feature_layouts.md
d8eb27c 
- intro example added
- Wording changed in sections to be less ambiguous or difficult for translators
- enforced use of document specific terminology
@dunk2k
Update feature_layouts.md
c11ccee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@dunk2k