pxt-microbit icon indicating copy to clipboard operation
pxt-microbit copied to clipboard

Added Electric guitar using Microbit project documentation in docs

Open akshitagupta15june opened this issue 3 years ago • 2 comments

issue #4818

Project using micro:bit

->Added code.md as well as make.md

->A youtube video for final project

akshitagupta15june avatar Jul 24 '22 09:07 akshitagupta15june

CLA assistant check
All CLA requirements met.

ghost avatar Jul 24 '22 09:07 ghost

@riknoll @jwunderl please review

akshitagupta15june avatar Aug 25 '22 04:08 akshitagupta15june

@ganicke please review

akshitagupta15june avatar Sep 11 '22 14:09 akshitagupta15june

@akshitagupta15june - Sorry that I didn't see the earlier review request. I'll will take a look at it tomorrow.

ganicke avatar Sep 12 '22 05:09 ganicke

I've put your pages under electric-guitar. We'll need to remove the duplicates in the other folder named Microbit-Electric-Guitar. Also, I've referenced images for the Make under the static path. You'll need to add those images to your branch.

Commit these actions to your branch to complete the Electric Guitar project:

Step 1

Please add these images in a folder created at: ./docs/static/mb/projects/electric-guitar

connections

connections.jpg

guitar-board1

guitar-board1.jpg

guitar-board2

guitar-board2.jpg

Step 2

Remove the files, and the folder itself, at Microbit-Electric-Guitar.

ganicke avatar Sep 13 '22 02:09 ganicke

Thankyou so much @ganicke for reviewing, I have made the required changes.

image

akshitagupta15june avatar Sep 13 '22 04:09 akshitagupta15june

@akshitagupta15june - We don't need a readme.md with the images so I removed that. Also, MakeCode docs aren't intended to be browsed on GitHub. They are served from a different service backend. So, we don't use the path prefix of ./docs for links as you might expect.

Hey, are you good at art? We'll need a thumbnail image to put in a 'card' for your project in the home screen gallery:

image

It can be drawn in the same "comic" style as the other Music projects. The image is uploaded just to ./docs/static/mb/projects folder. See ./docs/projects/music.md for reference. Your project will go in as the fourth entry in the gallery list.

Thanks!

ganicke avatar Sep 13 '22 20:09 ganicke

So i will make a icon for it but do i have to add the image in docs/static/mb/projects or just have to send here

akshitagupta15june avatar Sep 14 '22 01:09 akshitagupta15june

Hey @ganicke so I tried making a doodle just like what my electric guitar look like image

akshitagupta15june avatar Sep 14 '22 02:09 akshitagupta15june

let me know if anything more is required for this pr! @ganicke

akshitagupta15june avatar Sep 14 '22 17:09 akshitagupta15june

@akshitagupta15june - now, if you can upload this image and save it to your branch as ./docs/static/mb/projects/electric-guitar.png (it's skewed some since we need it as a 300x200 thumbnail), we can finish and publish this project. Thanks.

image

ganicke avatar Sep 14 '22 21:09 ganicke

@ganicke done!

Thankyou

akshitagupta15june avatar Sep 15 '22 01:09 akshitagupta15june

@ganicke i also updated the code.md because it had make.md link as /docs/projects---->/projects/electric-guitar

akshitagupta15june avatar Sep 16 '22 01:09 akshitagupta15june

Thankyou so much @ganicke for approving my pull request, its my first pr in microsoft repo, I would like to contribute more projects in this repo in future.

akshitagupta15june avatar Sep 16 '22 16:09 akshitagupta15june

@akshitagupta15june - you might experiment with the new play sound block and see if that might give even more realism to the guitar sounds.

ganicke avatar Sep 16 '22 17:09 ganicke

cool! I will see to it thanks!

akshitagupta15june avatar Sep 16 '22 17:09 akshitagupta15june

hey @ganicke the picture is not visible

here is the changes that i have made can help https://github.com/microsoft/pxt-microbit/pull/4856

image

actually the path you gave in music.md is /static/mb/projects/electric-guitar.png but the image is inside /static/mb/projects/electric-guitar/electric-guitar.png

akshitagupta15june avatar Sep 17 '22 04:09 akshitagupta15june

@akshitagupta15june - correct. I need the PNG in the folder specified in comment: https://github.com/microsoft/pxt-microbit/pull/4819#issuecomment-1247335581

ganicke avatar Sep 19 '22 23:09 ganicke