How fazreil/rk61-cheatsheet works
Main “Components”
• Cheatsheet Document – since the entire project is a documentation resource, this is your central component.
• Sections within the document – break down the README into its logical sections:
• Introduction: Describes the purpose of the cheatsheet.
• Shortcuts: Contains tables defining regular functions and RGB functions.
• Layers: Describes different key layers (Layer 1, Layer 2, Layer 3) with their corresponding key maps.
• Tricks: Offers additional tips (like directional keys behavior and cable connection quirks).
• Reference: Lists links to external resources and manuals.
Relationships and Interactions
• Since this is a single markdown document, the relationship is hierarchical; the document is segmented into logical sections that flow from one to the other.
Important Architectural Patterns
• “Document-as-Code” idea is evident here. Even though there’s no backend/frontend separation, the structure benefits from clear sectioning and consistency which mirrors the component-based approach in software design.
• The modular nature of each section (Introduction, Shortcuts, Layers, Tricks, References) can be viewed as independent blocks that overlay a unified purpose.
Relevant Technologies
• Markdown – The primary format for documenting the cheatsheet.
• Git (implied by the LICENSE and project structure).
• Web rendering (e.g., GitHub or static site generators) that will eventually display the cheatsheet.
Elements
• If desired, you could also include a side note component for “External Links/Manuals” linked out from the Reference section.