Skip to content

docs: add missing README files for four example directories#1297

Open
mitre88 wants to merge 1 commit intogetzep:mainfrom
mitre88:docs/add-missing-example-readmes
Open

docs: add missing README files for four example directories#1297
mitre88 wants to merge 1 commit intogetzep:mainfrom
mitre88:docs/add-missing-example-readmes

Conversation

@mitre88
Copy link

@mitre88 mitre88 commented Mar 4, 2026

Summary

This PR adds README documentation to four example directories that were previously missing them:

  • examples/podcast/ — Documents the podcast transcript processing example, including transcript parsing, multi-speaker episode ingestion, and temporal ordering.
  • examples/wizard_of_oz/ — Documents the literary text processing example using The Wizard of Oz, including the Anthropic LLM client usage and chapter-based episode splitting.
  • examples/ecommerce/ — Documents the e-commerce sales conversation example, covering product knowledge extraction and customer preference tracking.
  • examples/langgraph-agent/ — Documents the LangGraph integration example for building an interactive ShoeBot sales agent with Graphiti-powered memory.

Motivation

The examples/quickstart/, examples/azure-openai/, examples/opentelemetry/, and examples/gliner2/ directories all have README files, but the other four examples did not. This makes it harder for new users to discover and understand these examples.

Each README follows the same structure as the existing example READMEs:

  • Overview of what the example does
  • Prerequisites and setup instructions
  • How to run the example
  • Key concepts demonstrated
  • Cross-references to related examples

Changes

  • Added examples/podcast/README.md
  • Added examples/wizard_of_oz/README.md
  • Added examples/ecommerce/README.md
  • Added examples/langgraph-agent/README.md

No code changes.

@danielchalef
Copy link
Member


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 083363aa6c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

1. Install the required dependencies:

```bash
pip install graphiti-core python-dotenv

Choose a reason for hiding this comment

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

P1 Badge Install Anthropic extra before running Wizard of Oz example

The setup command omits the anthropic dependency even though runner.py imports AnthropicClient, whose module raises ImportError unless anthropic is installed (graphiti-core[anthropic] or anthropic directly). Following this README in a fresh environment will fail before the example can run.

Useful? React with 👍 / 👎.

## Running the Example

```bash
python runner.py

Choose a reason for hiding this comment

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

P1 Badge Document a runnable command for the Wizard of Oz runner

The documented command python runner.py does not work from examples/wizard_of_oz because runner.py uses from examples.wizard_of_oz.parser import ...; when run as a script from that directory, examples is not on sys.path and execution fails with ModuleNotFoundError. This needs a module-style invocation or adjusted import guidance so users can actually execute the example.

Useful? React with 👍 / 👎.

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.

2 participants