Code Monkey home page Code Monkey logo

keebio-docs's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

keebio-docs's People

Contributors

aceyoung9 avatar dependabot[bot] avatar gitbook-bot avatar hed854 avatar junongx avatar kwon11 avatar lolmaus avatar lukeg101 avatar lukehoggett avatar mxxivcz avatar nooges avatar pdc avatar phatcatmatt avatar psxndc avatar quadbyte avatar studentism avatar tpssim avatar valgrahf avatar youngheart80 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

keebio-docs's Issues

implement TG(layer) for iris

Hi there,

i'm quite new to the qmk firmware and in the process of creating my own keymap for the iris.
Therefore i want to have a second key for the LOWER layer that toggles the layer by pressing the key permanently until a second key press.
After inserting TG(LOWR) i get build errors.
I appreciate an advice.

Thank you.

Schematics for Viterbi 2.0

I noticed that Nyquist already has its Rev. 2 schematic uploaded in the page: https://docs.keeb.io/schematics/

May I ask if we have a timeline for when the Viterbi 2.0 schematic be uploaded?

I'm currently debugging why some of my rows and columns aren't working and a schematic would really be helpful.

Cheers!

Schematics not actually attached

I believe that in 04fa544 you meant to include the schematics for the BFO-9000 and Nyquist, but the schematics folder never made it into the commit. Could you either add the schematics folder, or, if you don't plan on doing that, remove the dead links from schematics.md

Thank you!

Investigate Docsify as documentation generator

Gitbook has been flaky lately with the transition to the new version of their system, and there have been various quirks to it that have been very annoying. Also, the only way to test how the docs will look is to publicly push files.

QMK is looking at different doc systems, like Docsify. See if that is a good alternative to use and if it's worth switching.

Add suggested supplies page

Add links to various items suggested for building keyboards including:

  • Soldering Iron
  • Solder
  • Desoldering pump/solder sucker
  • Wick
  • Flux
  • Flush cutters
  • Hookup wire

Missing correct scaling for Iris rev3/4 tented middle layer

Hello,

What is the correct scaling for this middle layer https://github.com/keebio/iris-case/blob/master/rev3-and-rev4/Iris%20R3%20Middle%20Layer%20-%20Tented%20for%201.5mm%20Plate.stl ?

Currently the README mentions to scale to 153.7mm x 133.9mm but that doesn't work for the tented version of the middle layer. There is an old version of the README which mentions 167.2mm x 132.5mm for the tented layer specifically but that doesn't work either (on Sculpteo).

Thanks,

Spacebar stabilizer in IMG_7935.jpg seems off by one

Build guide 'https://github.com/keebio/keebio-docs/blob/master/docs/quefrency-rev2-sinc-build-guide.md'

Unless I did something wrong (it was my first build so highly probable), I would update IMG_7935 in the build guide and move the spacebar stabilizer one notch to the right. This matches the the default keyboard layout in which the right-hand spacebar keycap is size 2.75. It looks like the build guide picture has the stabilizer set for a spacebar keycap of size 2.25?

Background:
I was using the guide plus the primary website pictures of the black/white/salmon build to figure where to put things.

In "Add 2u stabilizers to PCB", the fist picture shows a PCB and three stabilizers on it. I put mine as shown in that picture, but could not figure which spacebar keycaps to use. Any spacebar keycap from my set (from Cannonkeys) would show a gap to the left or right.

Finally I moved the spacebar stabilizer one notch to the right and everything worked well. It was hard to do because I had already soldered four switches at that time, so I had to break the current stabilizer out of the board, and squeeze a new one in place.

Note that Iris can't use I2C and underglow concurrently

I just built my iris and it took me a while to figure out why my qmk firmware that was compiled with I2C enabled wasn't working correctly and that was because I was using underglow as well.

Maybe you could make a note in the build guide that you can only use I2C or underglow and not both at the same time.

Mistake in the elite pi diagram

Hey there,

I noticed that the botttom row of the diagram is the same on both sides, even though one shows the board flipped over. Shouldn't the PIN numbers also be flipped?

Elite-Pi with KMK

How should Elite-Pi use KMK?
I didn't find any support for Elite-Pi on circuitpython,
and there is no part about KMK in Elite-Pi's firmware tutorial.

Suggestion: Use Hint Style to highlight notes or warnings

First up, the new docs are looking really good. Nice to see them coming together.

One I was going to suggest was using the hint style formatting similar to the QMK docs (also hosted in Gitbook) for the warnings and notes about MOSFET pads, etc. in the Iris build.

Example: QMK Getting Started page uses this syntax:
{% hint style='info' %} Not sure which text editor to use? Laurence Bradford wrote a great introduction to the subject. {% endhint %}

As I didn't have access via Gitbook, I didn't know how to go about testing it to see if it would work, or if that is something custom on the QMK folks have done above and beyond Gitbook.

Thoughts?

Iris Kaihl Low Profile Rev 2 has pictures for regular Iris PCB

The regular Iris PCB has the opposite vertical orientation of the diodes to the low profile version. The low profile build guide should show pictures of the low profile PCB with the black line of the diodes pointing up. It should also remove the line "On the bottom side of the PCB, insert diodes with the black line towards the bottom " or at least fix that to say "towards the top".

BDN9 Build Guide newbie pain points

Hi folks,

I picked up a BDN9 kit for my first mech build, thinking it would be a great way to learn about building keyboards. As a newbie, I ran into some confusion with the build guide that could probably be easily avoided.

  1. Flashing the Pro Micro
    Suggestion: Explain that after you reset the Pro Micro you only have 8 seconds to begin flashing it.

This information is buried in one of the linked guides (the Let's Split one) but it took me an hour of confusion and failed flashes to find it. I was worried about starting the flash too soon so I was always waiting too long to begin.

  1. Soldering the Pro Micro header pins
    Suggestion: remove this sentence from the guide: "You can go with not soldering the header pins in, but it is recommended to do so anyway for a more secure fit."

Seeing this sentence I thought, "I'll leave this not soldered just in case the usb connector breaks or something." Once I finally finished the kit and tried to test it, half the keys didn't work and the LEDs twitched on and off. The confusion caused by my trouble flashing the Pro Micro caused me to think I had a bad Pro Micro. It took me a few hours of debugging to understand that it was just bad connections and this "recommendation" was really a requirement.

  1. LED Underglow strips
    Suggestion: Include a photo of an LED strip mounted on the PCB as an example for those who choose to build that way instead of individual RGB LEDs.

The linked resources discuss other boards but don't help the user understand how to install in the BDN9.

Thanks for the great kit!

Build guides for Viterbi 2.0

Good Day!

We've recently bought PCBs and have noticed that they were marked as Viterbi 2.0. However, we couldn't find any documentation in the docs.

Is it more or less the same as with the Nyquist's?

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.