Skip to content

Update documentation with new tool examples #10

Description

@gnodet

Summary

The fix/async-sleep branch added two new tools (wait_for_text and find_highlighted) but the example files don't include usage examples for them. Additionally, docs/index.md is missing the Claude Code project-scoped config that was added to README.md.

Scope

1. Add examples for wait_for_text

Add a practical example to EXAMPLES.md showing:

  • Launching a TUI in buffer mode
  • Using wait_for_text to wait for async screen updates
  • Contrasting with expect_text (stream vs buffer)

2. Add examples for find_highlighted

Add a practical example to EXAMPLES.md showing:

  • Launching a menu-style TUI in buffer mode
  • Using find_highlighted to verify which item is selected
  • Using the bg parameter for specific color matching

3. Sync docs/index.md with README.md

  • Add the Claude Code project-scoped .mcp.json configuration example
  • Add the settings.local.json tip for non-interactive approval

Acceptance criteria

  • Both new tools have at least one complete example in EXAMPLES.md
  • docs/index.md includes Claude Code config
  • Examples are consistent with existing style

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions