Problem Statement

We think users have a hard time using the current Notebook Examples because it’s not organized well, some parts are confusing, and it doesn’t follow best practices. We don’t have hard data yet—this is based on what we’ve seen and heard. We want to improve the repo so it’s easier for people to find what they need and use the examples to learn.

Background/Context

The Notebook Examples repo (https://github.com/instructlab/examples) is a key resource for users learning how to work with InstructLab. Right now, it could be more helpful. The layout, explanations, and examples aren’t as clear or as easy to use as they could be. We want to update the repo to make it better for users.

• User Impact
  When users try to learn from the repo, they might:
• Struggle to find the examples they need.
• Not understand how the examples work or how to use them.
• Waste time trying to figure things out.
• Get frustrated and give up.

Proposed Solution

• Look at other example repositories (like Meta LLaMA Cookbooks, Hugging Face, Unsloth, AWS JumpStart) to learn from what they do well.
• Check if using Jupyter Books could help organize and explain the content better.
• Redesign the repo with a clear structure, easy-to-follow templates, and helpful guides.
• Write simple, clear guidelines for people who want to add new examples.

Acceptance Criteria

• The repo is updated with a new structure and templates.
• There are clear contribution guidelines in the repo.

Deliverable(s)

• https://docs.google.com/document/d/1FSRGtiHitxprvypcsr2oApqjZ6SP5i4HAonGkde_slY/edit?tab=t.0#heading=h.26yhsvav82u