Skip to content

Conversation

paytonison
Copy link

This pull request replaces the old introductory article on large language models with a new, more concise and practical guide aimed at developers. The new article, openai-cookbook-llms-101.md, provides hands-on code examples, covers core concepts, and highlights practical tips for working with LLMs in real applications.

Documentation update and improvement:

  • Removed the outdated how_to_work_with_large_language_models.md article, which was more verbose and less focused on code-first guidance.
  • Added a new article, openai-cookbook-llms-101.md, that delivers a practical, code-centric introduction to LLMs, including Python and JavaScript examples, quick-start guides, and explanations of key concepts like tokenization, embeddings, transformer layers, and sampling.

Developer-oriented enhancements:

  • The new guide emphasizes actionable advice, such as default parameter choices, streaming responses, prompt design, and common pitfalls, making it easier for developers to apply LLMs in real-world scenarios.
  • Includes a glossary and sections on limitations and best practices, helping developers avoid common mistakes and design robust LLM-powered apps.

Motivation

The original introductory article felt slapdash and more like something written by a person who’s long been working with AI, throwing together a random assortment of very basic things without clearly explaining the finer points of what an LLM really is and how they’ve evolved into so much more. It’s also more casual.


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.

@Copilot Copilot AI review requested due to automatic review settings September 27, 2025 03:17
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 PR modernizes the introductory documentation for LLMs by replacing the outdated how_to_work_with_large_language_models.md with a new developer-focused guide openai-cookbook-llms-101.md. The new article provides a practical, code-first introduction to LLMs with hands-on examples in both Python and JavaScript.

  • Removes verbose, less practical content and replaces it with concise, actionable guidance
  • Adds comprehensive code examples and streaming implementations
  • Includes practical tips on parameters, limitations, and common pitfalls

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
registry.yaml Adds entry for the new LLMs 101 article with metadata
authors.yaml Adds new author "paytonison" with profile information
articles/openai-cookbook-llms-101.md New comprehensive, code-focused LLM introduction guide
articles/how_to_work_with_large_language_models.md Removes the old introductory article

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

paytonison and others added 2 commits September 26, 2025 21:19
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@paytonison paytonison changed the title Intro rewrite Rewrite the Cookbook introduction to make it more accessible Sep 27, 2025
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