search

microsoft / pxt-microbit

A Blocks / JavaScript code editor for the micro:bit built on Microsoft MakeCode
https://makecode.microbit.org
Other
711 stars 589 forks source link

WebUSB usage requires new documentation #1293

Closed abchatra closed 5 years ago

abchatra commented 5 years ago

WebUSB requires better documentation.

As of today we link to following two links

  1. https://makecode.microbit.org/v1/device/usb/webusb - Help redirects here
  2. https://makecode.microbit.org/v1/device/usb/webusbfirmware - Check your firmware version and update if necessary redirects here. This one is 404 and requires new documentation.

For (1) we need pictures and clear documentaiton and serial output details. (Currently it says console.log and we don't have console.log in microbit).

For (2) may be reuse contents here: https://makecode.microbit.org/device/windows-app/troubleshoot

image

abchatra commented 5 years ago

@ganicke let me know if you need any information here. @pelikhan fyi

pelikhan commented 5 years ago

I suggest that (1) points to (2) and not the foundation ticket. It's not clear and not localizable. For 2, I we already have https://makecode.microbit.org/device/firmware we should beef it up.

pelikhan commented 5 years ago

Actually @abchatra is right, the windows troubleshoot page is better. We spent quite a bit of time and feedback to tune it. We should clone it do the same for webusb.

jaustin commented 5 years ago

How long is the existing webUSB pairing UX sticking around for? I think it'd be really useful to have some kind of indicator about whether direct downloads are 'on' or 'off' in the main view.

I was wondering about something like this for when we're ready to make webUSB much more visible: image

As a starter for 10: If you toggle the option 'on' on Chrome it starts webUSB pairing. If you're !Chrome on W10 it tells you about the W10 app and anywhere else it says "This feature is currently only available for your platform via Chrome"

Other option would be to only show it when on Chrome or Windows 10, and in the W10 app, toggled to 'on' by default.

abchatra commented 5 years ago

Interesting idea. We had a slightly different one where we would advertise webusb on every download. We parked these ideas until we see decent usage with webusb. Majority of teachers are not going to upgrade to new firmware. We will need to wait for the adoption of new hardware to make use of this feature.

Issue with the toggle button design is we don't have enough space for button in tablet view. We

guillaumejenkins commented 5 years ago

A checkmark on the download button maybe? But then again maybe on smaller screens we won't have room either

pelikhan commented 5 years ago

Different icon - swap to usb when paired

Get Outlook for iOShttps://aka.ms/o0ukef

From: Guillaume Jenkins notifications@github.com Sent: Wednesday, September 26, 2018 8:05 AM To: Microsoft/pxt-microbit Cc: Peli de Halleux; Mention Subject: Re: [Microsoft/pxt-microbit] WebUSB usage requires new documentation (#1293)

A checkmark on the download button maybe? But then again maybe on smaller screens we won't have room either

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2Fpxt-microbit%2Fissues%2F1293%23issuecomment-424749808&data=02%7C01%7Cjhalleux%40microsoft.com%7C148fc029415e4d12dde108d623c18fe5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636735711580783464&sdata=a7pKyqC1JhBkjUEsO7FhnTLLdL3JyYGPBig%2B6JIIqbc%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAD-4KdDxPHF2fHRTwhKqZtRIr20DAVCpks5ue5fUgaJpZM4W5PzM&data=02%7C01%7Cjhalleux%40microsoft.com%7C148fc029415e4d12dde108d623c18fe5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636735711580783464&sdata=vXoQ%2FqtmGNTeyddtTL6oKfCTYz2tfCAQJ%2BbVxfwq1g8%3D&reserved=0.

pelikhan commented 5 years ago

@jaustin where is the "official" firmware download page. The instructions to upgrade to 0250 are extremely hard to follow right. We need a direct URL to download the firmware .hex file from our docs.

jaustin commented 5 years ago

@pelikhan we're building a page on microbit.org rather than the knowledge base so it'll be translatable. @microbit-mark and I were discussing this earlier this morning and it's in flight but I wouldn't expect that page out this week :)

pelikhan commented 5 years ago

We can update our docs later when you've got something up.

pelikhan commented 5 years ago

Docs have been updated.

lock[bot] commented 4 years ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.