Skip to content

Improve example README.md docs#283

Merged
davideast merged 2 commits intomainfrom
docs/example-readmes
Mar 16, 2026
Merged

Improve example README.md docs#283
davideast merged 2 commits intomainfrom
docs/example-readmes

Conversation

@davideast
Copy link
Copy Markdown
Collaborator

Each README now covers:

  • Concise description of what the example does
  • Quick Start with all required env vars
  • Example-specific sections explaining key SDK patterns
  • Code snippets for the interesting parts
  • Configuration tables where applicable
  • Key file listings
  • Add PORT env var to hono and webhook (source + README)
  • Add WATCH_DIR env var with path traversal guard to file-system-events
  • Fix GitHub Actions secret instructions (GITHUB_TOKEN is automatic)
  • Add concrete diff block examples to gitpatch-improve and gitpatch-review
  • Replace service account assumption with ADC options (OAuth + service account)
  • Add Google Cloud project prerequisite to google-docs and google-sheets

…umentation

Each README now covers:
- Concise description of what the example does
- Quick Start with all required env vars
- Example-specific sections explaining key SDK patterns
- Code snippets for the interesting parts
- Configuration tables where applicable
- Key file listings

No generic headings — every section heading describes the specific
feature or pattern being demonstrated.
…mples, and secret instructions

- Add PORT env var to hono and webhook (source + README)
- Add WATCH_DIR env var with path traversal guard to file-system-events
- Fix GitHub Actions secret instructions (GITHUB_TOKEN is automatic)
- Add concrete diff block examples to gitpatch-improve and gitpatch-review
- Replace service account assumption with ADC options (OAuth + service account)
- Add Google Cloud project prerequisite to google-docs and google-sheets
@davideast davideast merged commit 57cc289 into main Mar 16, 2026
5 checks passed
@davideast davideast deleted the docs/example-readmes branch March 16, 2026 16:33
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