Skip to content

[Docs/Website] Add documentation about how to create examples #229

Open
@andrewmusselman

Description

@andrewmusselman

It would be helpful to have a clear guide on how to create and contribute example notebooks.

This documentation should:

  • Emphasize the use of Google Colab as the preferred environment, since it provides a clean and reproducible setup for running notebooks.
  • Follow the structure and style established in:
    • website/developers/contribute_agentic_framework.md
    • website/developers/contribute_tool.md

The goal is to make it easy for contributors to add meaningful examples that are easy to run, understand, and maintain. Ideally, the documentation would include:

  • Naming conventions
  • Where to place the examples
  • Tips for making examples lightweight but informative
  • How to link examples from relevant documentation pages

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions