Skip to content

Conversation

paytonison
Copy link

This pull request updates documentation to clarify notebook naming conventions. The main change is to ensure new notebooks use lowercase, dash-or-underscore-separated names that match their directory, specifically updating the example path to use examples/prompting instead of examples/gpt-5.

  • Documentation: Updated the example notebook naming convention in AGENTS.md to reference the correct directory (examples/prompting/prompt-optimization-cookbook.ipynb) for clarity and consistency.

Motivation

Prompting is the final frontier of AI models, regardless of the kind. A vast majority of issues people experience with AI models can be solved by prompting well. These are some basic examples with some decent advice for newbies, but they were all over the place. This solves that.

If there are issues, blame Codex.

  • 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.

@Copilot Copilot AI review requested due to automatic review settings September 27, 2025 04:00
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request reorganizes prompting-related example notebooks by consolidating them into a single examples/prompting directory. The changes update file paths in the registry and documentation to reflect this new organizational structure.

  • Moved 13 notebook entries from various directories (examples/, examples/gpt-5/, examples/o-series/) to examples/prompting/
  • Updated documentation example to reference the new directory structure
  • Maintained all existing metadata (dates, authors, tags) while updating only the file paths

Reviewed Changes

Copilot reviewed 2 out of 154 changed files in this pull request and generated no comments.

File Description
registry.yaml Updated paths for 13 prompting-related notebooks to use the new examples/prompting/ directory structure
AGENTS.md Updated the example notebook naming convention to reference the correct directory path

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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