Skip to content

docs: add /examples folder #351

Open
@cyclotruc

Description

@cyclotruc

Create an examples/ folder containing practical examples demonstrating various ways to use both the CLI and Python package. This will significantly improve the contributor experience and make the project more accessible to new users.
Motivation

New users need concrete examples to understand how to use the tool effectively
AI agents would benefit from clear usage patterns and examples
Reduces the learning curve for contributors
Complements existing documentation with hands-on examples

Examples should be self-contained and runnable
Include comments explaining key concepts
Consider adding expected output for CLI examples
Examples should cover both basic and advanced use cases

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions