Skip to content

docs: add Examples section linking the two example repos#11

Open
Sriram567 wants to merge 1 commit into
mainfrom
docs/examples-section
Open

docs: add Examples section linking the two example repos#11
Sriram567 wants to merge 1 commit into
mainfrom
docs/examples-section

Conversation

@Sriram567

Copy link
Copy Markdown
Contributor

Summary

Adds a small "Examples" section before "Links" with cross-links to both runnable example repos:

  • example-percy-maestro — BrowserStack App Automate Maestro example.
  • example-percy-maestro-selfhosted — Self-hosted (non-BrowserStack) Maestro example, just published. Demonstrates the cli#2248 + cli#2254 self-hosted path with Android (Sample Calculator) and iOS (simulator + Settings) flows.

Why

Customers looking for runnable examples currently have no pointer from the SDK README. This adds bidirectional discoverability between the SDK and its example repos.

Scope

Surgical insertion above the existing Links section. Does not touch the Runtime support or Installation sections — those still claim BS-only and are owned by the in-flight self-hosted SDK PR (#7), which will update them as part of that work. Keeping this PR small lets it land independently regardless of #7's status.

Testing

  • Markdown renders cleanly (verified via gh pr view --web after push).
  • Both linked repos exist and are public.
  • No code changes; SDK behavior unchanged.

Post-Deploy Monitoring & Validation

No additional operational monitoring required: documentation-only change with no runtime impact.

🤖 Generated with Claude Opus 4.7 via Claude Code + Compound Engineering v2.54.0

Adds a small "Examples" section before "Links" pointing customers at
the two runnable example repos:

- example-percy-maestro (BrowserStack-hosted path)
- example-percy-maestro-selfhosted (new — self-hosted / non-BS path)

Surgical insertion above the existing Links section. Does not touch
the Runtime support or Installation sections — those are owned by the
in-flight self-hosted SDK PR (#7) and will be updated there.
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.

1 participant