Skip to content

fix: broken image links in deep research notebooks #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ali90h
Copy link

@ali90h ali90h commented Jul 29, 2025

Summary

Fixes broken image links in the two Deep‑Research notebooks (introduction_to_deep_research_api.ipynb and introduction_to_deep_research_api_agents.ipynb).
The relative paths (../images/*.png) were replaced with raw GitHub URLs so the images render correctly on GitHub and the cookbook website.

Motivation

Readers of the Deep‑Research notebooks currently see missing‑image icons, which makes the tutorial harder to follow.
Updating the links restores the diagrams, improving clarity and the overall quality of the documentation.


For new content

Not applicable: this PR only patches existing notebooks, it does not introduce new articles or examples, so no registry.yaml entry is needed.

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant