Skip to content

docs: add getting started guide for examples#10

Open
LottR079 wants to merge 1 commit intoPolymarket:mainfrom
LottR079:examples-getting-started-guide
Open

docs: add getting started guide for examples#10
LottR079 wants to merge 1 commit intoPolymarket:mainfrom
LottR079:examples-getting-started-guide

Conversation

@LottR079
Copy link

@LottR079 LottR079 commented Dec 2, 2025

a separate file docs/getting-started-with-examples.md appeared with a step-by-step “getting started” guide: how to install dependencies, configure .env based on .env.example and run TypeScript examples via ts-node without any guesswork.


Note

Add a concise getting-started doc for running the repository’s TypeScript examples locally.

  • Documentation:
    • New guide: docs/getting-started-with-examples.md
      • Describes example types and location (examples/).
      • Lists prerequisites and secret handling.
      • Provides dependency installation steps (yarn install) and notes running via ts-node.

Written by Cursor Bugbot for commit 33904ea. This will update automatically on new commits. Configure here.

a separate file docs/getting-started-with-examples.md appeared with a step-by-step “getting started” guide: how to install dependencies, configure .env based on .env.example and run TypeScript examples via ts-node without any guesswork.
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