diff --git a/.gitmodules b/.gitmodules index 889b2af..05c9e6f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -3,7 +3,7 @@ url = https://github.com/intel/tinycbor [submodule "python-fido2"] path = python-fido2 - url = https://github.com/SoloKeysSec/python-fido2 + url = https://github.com/solokeys/python-fido2 [submodule "crypto/micro-ecc"] path = crypto/micro-ecc url = https://github.com/kmackay/micro-ecc.git @@ -12,4 +12,4 @@ url = https://github.com/kokke/tiny-AES-c [submodule "targets/stm32l442/dfuse-tool"] path = targets/stm32l442/dfuse-tool - url = https://github.com/SoloKeysSec/dfuse-tool + url = https://github.com/solokeys/dfuse-tool diff --git a/README.md b/README.md index e95130f..343554c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![License](https://img.shields.io/github/license/solokeyssec/solo.svg)](https://github.com/SoloKeysSec/solo/blob/master/LICENSE) -[![Build Status](https://travis-ci.com/SoloKeysSec/solo.svg?branch=master)](https://travis-ci.com/SoloKeysSec/solo) +[![License](https://img.shields.io/github/license/solokeys/solo.svg)](https://github.com/solokeys/solo/blob/master/LICENSE) +[![Build Status](https://travis-ci.com/solokeys/solo.svg?branch=master)](https://travis-ci.com/solokeys/solo) [![Discourse Users](https://img.shields.io/discourse/https/discourse.solokeys.com/users.svg)](https://discourse.solokeys.com) [![Keybase Chat](https://img.shields.io/badge/chat-on%20keybase-brightgreen.svg)](https://keybase.io/team/solokeys.public) @@ -34,10 +34,10 @@ Solo for Hacker is a special version of Solo that let you customize its firmware You can only buy Solo for Hacker at [solokeys.com](https://solokeys.com), as we don't sell it on Amazon and other places to avoid confusing customers. If you buy a Hacker, you can permanently lock it into a regular Solo, but viceversa you can NOT take a regular Solo and turn it a Hacker. -If you have a Solo for Hacker, here's how you can load your own code on it. You can find more details, including how to permanently lock it, in our [documentation](https://solo.solokeys.io/building/). +If you have a Solo for Hacker, here's how you can load your own code on it. You can find more details, including how to permanently lock it, in our [documentation](https://docs.solokeys.io/solo/building/). ```bash -git clone --recurse-submodules https://github.com/SoloKeysSec/solo +git clone --recurse-submodules https://github.com/solokeys/solo cd solo cd targets/stm32l432 @@ -52,7 +52,7 @@ python tools/solotool.py program targets/stm32l432/solo.hex If you forgot the `--recurse-submodules` when cloning, simply `git submodule update --init --recursive`. -For example, if you want to turn off any blue light emission, you can edit [`led_rgb()`](https://github.com/SoloKeysSec/solo/blob/master/targets/stm32l432/src/led.c#L15) and force: +For example, if you want to turn off any blue light emission, you can edit [`led_rgb()`](https://github.com/solokeys/solo/blob/master/targets/stm32l432/src/led.c#L15) and force: ``` uint32_t b = 0; ``` @@ -69,7 +69,7 @@ A frequently asked question is whether Solo for Hacker is less secure than regul Clone Solo and build it ```bash -git clone --recurse-submodules https://github.com/SoloKeysSec/solo +git clone --recurse-submodules https://github.com/solokeys/solo cd solo make all ``` @@ -97,12 +97,12 @@ Or any client example such as: python python-fido2/examples/credential.py ``` -You can find more details in our [documentation](https://solo.solokeys.io), including how to build on the the NUCLEO-L432KC development board. +You can find more details in our [documentation](https://docs.solokeys.io/solo/), including how to build on the the NUCLEO-L432KC development board. # Documentation -Check out our [official documentation](https://solo.solokeys.io). +Check out our [official documentation](https://docs.solokeys.io/solo/). # Contributors diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index b29e554..0000000 --- a/docs/index.md +++ /dev/null @@ -1,4 +0,0 @@ -Welcome to the technical documentation for [solokeyssec/solo](https://github.com/solokeyssec/solo). - -For now, you can read the repository `README.md`, more documentation to come! - diff --git a/docs/repo-readme.md b/docs/repo-readme.md deleted file mode 120000 index 32d46ee..0000000 --- a/docs/repo-readme.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/building.md b/docs/solo/building.md similarity index 100% rename from docs/building.md rename to docs/solo/building.md diff --git a/docs/code-overview.md b/docs/solo/code-overview.md similarity index 100% rename from docs/code-overview.md rename to docs/solo/code-overview.md diff --git a/docs/contributing.md b/docs/solo/contributing.md similarity index 71% rename from docs/contributing.md rename to docs/solo/contributing.md index a200f01..1728356 100644 --- a/docs/contributing.md +++ b/docs/solo/contributing.md @@ -1,6 +1,6 @@ We are very open to contributions! -[Currently](https://github.com/solokeyssec/solo/issues), most work will go towards +[Currently](https://github.com/solokeys/solo/issues), most work will go towards * implementing STM32L432 * implementing NFC @@ -8,7 +8,7 @@ We are very open to contributions! In the future, we would love to see creative plugins/extensions, putting the TRNG and other features of the STM32L432 to good use! -Feel free to send a [pull request](https://github.com/SoloKeysSec/solo/pulls) at any time, we don't currently have a formal contribution process. +Feel free to send a [pull request](https://github.com/solokeys/solo/pulls) at any time, we don't currently have a formal contribution process. If you want to discuss your plans in quasi-realtime beforehand, you can also join our [solokeys.public](https://keybase.io/team/solokeys.public) Keybase team. diff --git a/docs/documenting.md b/docs/solo/documenting.md similarity index 100% rename from docs/documenting.md rename to docs/solo/documenting.md diff --git a/docs/fido2-impl.md b/docs/solo/fido2-impl.md similarity index 98% rename from docs/fido2-impl.md rename to docs/solo/fido2-impl.md index 4747516..d0d5890 100644 --- a/docs/fido2-impl.md +++ b/docs/solo/fido2-impl.md @@ -21,7 +21,7 @@ When you register a service with a FIDO2 or U2F authenticator, the authenticator must generate a new keypair unique to that service. This keypair could be stored on the authenticator to be used in subsequent authentications, but now a certain amount of memory needs to be allocated for this. On embedded -devices, there isn't much memory to spare and users will allows frustratingly +devices, there isn't much memory to spare and users will always frustratingly hit the limit of this memory. The answer to this problem is to do key wrapping. The authenticator just diff --git a/docs/solo/images/favicon.ico b/docs/solo/images/favicon.ico new file mode 100644 index 0000000..c5dfb60 Binary files /dev/null and b/docs/solo/images/favicon.ico differ diff --git a/docs/images/logo.svg b/docs/solo/images/logo.svg similarity index 100% rename from docs/images/logo.svg rename to docs/solo/images/logo.svg diff --git a/docs/solo/index.md b/docs/solo/index.md new file mode 100644 index 0000000..ab5ffdb --- /dev/null +++ b/docs/solo/index.md @@ -0,0 +1,4 @@ +Welcome to the technical documentation for [solokeys/solo](https://github.com/solokeys/solo). + +For now, you can read the repository `README.md`, more documentation to come! + diff --git a/docs/solo/repo-readme.md b/docs/solo/repo-readme.md new file mode 120000 index 0000000..fe84005 --- /dev/null +++ b/docs/solo/repo-readme.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/docs/signed-updates.md b/docs/solo/signed-updates.md similarity index 100% rename from docs/signed-updates.md rename to docs/solo/signed-updates.md diff --git a/docs/udev.md b/docs/solo/udev.md similarity index 92% rename from docs/udev.md rename to docs/solo/udev.md index d8ad228..4959b13 100644 --- a/docs/udev.md +++ b/docs/solo/udev.md @@ -1,6 +1,6 @@ # tl;dr -Create [`/etc/udev/99-solo.rules`](https://github.com/SoloKeysSec/solo/blob/master/99-solo.rules) and add the following (which assumes your user is in group `plugdev`): +Create [`/etc/udev/99-solo.rules`](https://github.com/solokeys/solo/blob/master/99-solo.rules) and add the following (which assumes your user is in group `plugdev`): ``` # Solo @@ -69,4 +69,4 @@ udevadm trigger | U2F Zero | 0483 | a2ca | ## You got this all wrong, I can't believe it! -Are you suffering from [us being wrong](https://xkcd.com/386/)? Please, send us a [pull request](https://github.com/SoloKeysSec/solo/pulls) and prove us wrong :D +Are you suffering from [us being wrong](https://xkcd.com/386/)? Please, send us a [pull request](https://github.com/solokeys/solo/pulls) and prove us wrong :D diff --git a/mkdocs.yml b/mkdocs.yml index 2822e2e..55925aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,9 @@ -site_name: Solo +site_name: Solo Technical Documentation site_author: SoloKeys site_description: 'Documentation for the SoloKeys solo software' -repo_url: 'https://github.com/solokeyssec/solo' -repo_name: 'solokeyssec/solo' +site_url: 'https://docs.solokeys.io/solo/' +repo_url: 'https://github.com/solokeys/solo' +repo_name: 'solokeys/solo' copyright: 'Copyright © 2018 - 2019 SoloKeys' nav: @@ -18,4 +19,5 @@ nav: theme: name: material - logo: 'images/logo.svg' + logo: 'solo/images/logo.svg' + favicon: 'solo/images/favicon.ico' diff --git a/targets/stm32l432/README.md b/targets/stm32l432/README.md index be55b7a..58af397 100644 --- a/targets/stm32l432/README.md +++ b/targets/stm32l432/README.md @@ -1,4 +1,4 @@ -# STM32L4xx Solo +# STM32L432 Solo -Check out our [official documentation](https://solo.solokeys.io/building/) +Check out our [official documentation](https://docs.solokeys.io/solo/building/) for instructions on building and programming!