Conversation

erikakettleson-openai

Summary

This PR updates the root .gitignore to scope the dist/ and lib/ ignore rules to the top level only. This change ensures that JavaScript/TypeScript examples within the examples/ directory can include their own dist/ and lib/ folders, which are often needed for compiled or bundled output. It also adds the necessary build output files for the voice_solutions/one_way_translation_using_realtime_api example.

Motivation

The cookbook currently assumes a Python build structure, where dist/ and lib/ are safe to ignore globally. However, JavaScript/TypeScript projects use these folders for runtime artifacts. The existing rules unintentionally suppress these files from being committed, which breaks TypeScript-based examples that rely on compiled output. This change keeps the Python build hygiene intact while enabling cross-language flexibility in examples.

For new content

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 . Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

@erikakettleson-openai