[DOC] Bring the Jupyter workaround tips elsewhere in the documentation

[Vincent-Maladiere]

Hey Pydantic, thank you for this project.

Reference
#144 raises the issue of being unable to run the example in the doc, later fixed by #214

Doc improvement request
#214 put the work around notice only in the "Agent" section, which makes it barely visible in the documentation as a whole. For instance, I ran into this issue while testing function tools, in the corresponding section.

Does it make sense to add this workaround notice to the main tutorial pages? I guess many new users will run into this, and some might not take the time to check your GitHub issue tracker.

Thanks

[samuelcolvin]

I would suggest a better solution is to add a "trouble shooting" section to the docs, and include the point there.

[andrewdmalone]

Got this done with #583. Please let me know if it would be better to organize differently - I had to guess what we mean by "section" here but it's an easy change if we want to put it elsewhere.

[andrewdmalone]

Here's the appearance of the new section

[dAIsySHEng1]

Nice work - Andrew! Was working on this earlier today but didn't get around to making a PR (#584) until now. In addition to a Jupyter Notebook errors section, I also had a quick section about API Keys. Perhaps we can combine our PRs in some fashion?

Here's what things look like:

Anyways, happy New Year to all!

[andrewdmalone]

Nice work - Andrew! Was working on this earlier today but didn't get around to making a PR (#584) until now. In addition to a Jupyter Notebook errors section, I also had a quick section about API Keys. Perhaps we can combine our PRs in some fashion?

ehh it's a simple enough change that there's no need to make things complicated - let's just see what the people in charge want

[sydney-runkle]

I think we should definitely include the API keys section, thanks @dAIsySHEng1 for the contribution here!

[sydney-runkle]

Done by the above PRs, thanks folks!

[andrewdmalone]

@dAIsySHEng1 @sydney-runkle on mobile here so not sure how to reference the specific line

The old comment about Jupyter notebooks needs to be removed as well. @dAIsySHEng1 you can find those lines in my PR references above if you want to add the change to yours.