bastardkb/bastardkb.github.io

bastardkb.github.io's Issues

Scylla BG: Rainbow animation

The scylla guide mentions the rainbow animation in the testing section, but it does not have any effect save for the default static red enabled.

required tools: specify screwdriver sizes

The required screwdrivers should be specified as TXnn, such as TX10 for the larger screws used in the Dilemma. The given M3/M4 sizes refer to the thread and only relate to the driver interface indirectly.

add keymap pictures to the docs

With #12 almost merged,

• place the pictures somewhere in the docs
• link to the pics from the qmk readme's
• remove old keymap pictures from qmk*
• add dilemma / dilemma max pics

Keymap pictures to remove:

• https://github.com/Bastardkb/bastardkb-qmk/tree/bkb-master/keyboards/bastardkb/charybdis/4x6/keymaps/via#layout
• https://github.com/Bastardkb/bastardkb-qmk/tree/bkb-master/keyboards/bastardkb/charybdis/3x5/keymaps/via#layout

Optional:

• add layout pictures to the bastardkb.com product pages

About where to place the pictures -
I'm open to discussion, but my initial ideas are in:

• "customizing your keyboard" section of each guide
• link to those pages in a new "keymaps" document in the firmware section

scylla bg long-fix: remove mention of rainbow

In regards to issue #14
Once we fixed the RGB effects with the Scylla, Skeletyl, TBK Mini we should rollback the changes to the docs

Make it clear that the USB goes to the right side

Including comment from discord:

burkfers — Aujourd’hui à 09:26
As for "not the left": We should also double check the build guides to see if that might warrant being made clearer. Questions about this feel like they've become more common relative to other issues ever since the new docs.
(Mostly "I'm testing in via and the keys are reversed and a thumb won't work, help")
balanstik | Quentin — Aujourd’hui à 09:34
hmm, good point
in
the key testing part before installing into the case
the final part, connecting the cables

Show top bar items in mobile view

The mobile-friendly stylesheet hides elements from the top bar visible in desktop view.

Once #2 is merged, this also hides the dark mode toggle from mobile view.

We should estimate the effort required to show at least that toggle to mobile users and decide whether it's realistic for us to attempt to change.

Highlight silkscreen mismatch info more

The cnano build guide mentions the silkscreen row label mismatch, but it's a simple info box without a highlight, hidden at the bottom of the section after two images.

http://docs.bastardkb.com/bg_cnano/09cables_to_splinky.html#left-side

This could be changed from a note to an info or even warning to make it less easy to miss.

Specify lack of polarity on capacitors

We should specify that the orientation for the capacitors used for RGB does not matter to reduce potential confusion. An info box or even just a sentence in the text body should suffice.

Dark theme

Add a toggle for dark theme
Justthedocs supports a default dark scheme: https://just-the-docs.com/docs/customization/#custom-schemes

I'd like to rework it a bit to have it a bit more "on brand" - have to figure out which colors work best.

They also support dynamic theme switching : https://just-the-docs.com/docs/customization/#switchable-custom-scheme
So we'd have to add a button somewhere on the page

Idea: add it to the top right as a moon logo, and replace the "BK on github" text by a github logo

Testing before case installation

The recommendation to test everything before going to install the switches is either missing or requires more visibility. This affects at least the Charybdis guides.

diode installation confusing on charybdis

By sidx64:

Would recommend using the right thumb cluster pic to show the diode placement in the right side section so that people don’t confuse themselves.

I saw this pic in the right side section and was searching for two diode pads placed next to each other - which is the case only in the left thumb cluster

Where to find 3d Parts

We got feedback that it's not obvious where to find the 3d parts.
It'd be nice to add a link to the github specific part in the guide, maybe in the introduction.
Also, add that link on the website's product pages.