pico-sdk icon indicating copy to clipboard operation
pico-sdk copied to clipboard

Add information on targetting the Pico W. Fixes #895

Open lbt opened this issue 3 years ago • 10 comments

Now the Pico W is available the ability to target specific boards via cmake defines is a relevant addition to the introductory documentation.

lbt avatar Jul 02 '22 10:07 lbt

The PDFs are linked to from https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html :slightly_smiling_face:

EDIT: And the rptl.io links in https://github.com/raspberrypi/pico-sdk/blob/master/README.md#documentation are actually redirects to the existing PDFs. We'll be creating suitable rptl.io redirect links for the new documentation PDFs on Monday, thanks for the indirect-reminder that we need to do this :laughing:

lurch avatar Jul 02 '22 12:07 lurch

I hope the title and description are now suitable?

Re pdf links - so they are - I couldn't recall how I'd arrived at the pdf docs and was looking for direct links in this repo :) Is the pdf source public?

lbt avatar Jul 02 '22 15:07 lbt

Is the pdf source public?

Nope. The PDFs themselves are licensed under CC BY-ND but the source for the PDFs isn't public.

lurch avatar Jul 02 '22 15:07 lurch

@lurch you had commented this also related to something you were doing

kilograham avatar Jul 20 '22 20:07 kilograham

ping @aallan Do we have rptl.io links for the new Pico-W-specific PDFs?

lurch avatar Jul 21 '22 11:07 lurch

I hope the title and description are now suitable?

Re pdf links - so they are - I couldn't recall how I'd arrived at the pdf docs and was looking for direct links in this repo :) Is the pdf source public?

All the PDF documentation is linked from the microcontroller section of our online documentation, see https://www.raspberrypi.com/documentation/microcontrollers/.

aallan avatar Jul 21 '22 11:07 aallan

ping @aallan Do we have rptl.io links for the new Pico-W-specific PDFs?

Not sure why we really need them. But I mean, I can create some if you want?

http://rptl.io/picow-connect -> https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf http://rptl.io/picow-datasheet -> https://datasheets.raspberrypi.com/picow/pico-w-datasheet.pdf

aallan avatar Jul 21 '22 11:07 aallan

I was thinking it might be useful to add them to https://github.com/raspberrypi/pico-sdk/blob/develop/README.md#documentation along with the other short-links. Do you want to add in the http://rptl.io/picow-connect link to README.md in this PR @lbt ?

(Also, we could/should add them to https://github.com/raspberrypi/pico-sdk/blob/develop/docs/DoxygenLayout.xml and https://github.com/raspberrypi/pico-sdk/blob/develop/docs/weblinks_page.md too? :man_shrugging: )

lurch avatar Jul 21 '22 12:07 lurch

This just cost me an hour of debugging with my brand new Pico W board. 😭

The very first thing you're directed to do via the getting started is creating the blink example and that had me stumped.

I would go so far as to say, make this a bold gotcha warning on the top part of the readme. or else make it something CMake complains about if not specified.

Yes, eventually I managed to find the parts of the raspberrypi.com page which reference the pico W needing special configuration. Though even then it references it only in combination with wanting the wifi module to work, which surely isn't somthing I need to pay attention to when trying to get a LED blinking?

JamesWP avatar Sep 27 '22 22:09 JamesWP

I didn't add a link to the pdf because all that has is the example in 2.2 which you have to read the command line and go "ah hah!" like I did... there's no mention in the text. James' link is better

I do wonder how many people have wasted time since July on this commit being approved. It may not be perfect but surely it's an improvement. We're not carving into stone tablets here so reverting or clarifying this information over time is trivial.

https://en.wikipedia.org/wiki/Perfect_is_the_enemy_of_good ;)

lbt avatar Oct 11 '22 08:10 lbt