microsoft / pxt-ev3

Microsoft MakeCode editor for the LEGO MINDSTORMS EV3 Brick
https://makecode.mindstorms.com/
Other
55 stars 39 forks source link

New approved repos lib #1041

Closed THEb0nny closed 9 months ago

THEb0nny commented 1 year ago

Moved the addition of extensions to a separate PR.

jwunderl commented 1 year ago

As mentioned over here https://github.com/microsoft/pxt-ev3/pull/1038#discussion_r1380835526 there'll be a few changes we need to add as approved:

THEb0nny commented 1 year ago

As mentioned over here #1038 (comment) there'll be a few changes we need to add as approved:

  • needs icon; see icon.png in the https://github.com/microsoft/makecode-minecraft-music block
  • docs for blocks; see the code for how they're referenced / stored in docs/, and good to add a short description in readme since that'll show up as well
  • needs MIT license
  • We have been avoiding throwing things in subcategories as students often find them hard to identify / realize they have to click into Sensors for the category to show up; likely best to add it as a top level category just below HiTechnic. that's not a requirement though / just how we've been doing things.

icon png I will add, I will add documentation, the mit license is already specified.

THEb0nny commented 1 year ago

@jwunderl I tried providing a link to help, like in the extension you provided. When you click on the help button on the block, nothing opens. //% help=github:makecode-ev3-hitechnic-color-sensor-v2/docs/all

Just as I said before, I added an image, but it does not appear in the expansion cards.

THEb0nny commented 1 year ago

I also implemented a structure following the example of a color sensor extension. I specified the files in pxt.json, but still nothing appears when I click on help.

image

THEb0nny commented 11 months ago

@jwunderl look here please?

jwunderl commented 9 months ago

I also implemented a structure following the example of a color sensor extension. I specified the files in pxt.json, but still nothing appears when I click on help.

image

it looks like those paths are missing docs/ at the beginning (/reference/... => docs/reference/... in the files list), and it looks like the help paths are pointing as if they were built in docs -- here's an example from that minecraft ext repo showing the format for referencing your own extensions docs: https://github.com/microsoft/makecode-minecraft-music/blob/main/src/note.ts#L81

THEb0nny commented 9 months ago

@jwunderl thank you for your cooperation, I will try to fix all remaining problems.

THEb0nny commented 9 months ago

it looks like those paths are missing docs/ at the beginning (/reference/... => docs/reference/... in the files list), and it looks like the help paths are pointing as if they were built in docs -- here's an example from that minecraft ext repo showing the format for referencing your own extensions docs: https://github.com/microsoft/makecode-minecraft-music/blob/main/src/note.ts#L81

@jwunderl, I changed it, but the help does not open. If you get a chance, take a look... https://github.com/THEb0nny/makecode-ev3-hitechnic-color-sensor-v2