Skip to content

README quickstart — first successful API call in 60 seconds#15

Merged
IISweetHeartII merged 2 commits intomainfrom
feat/readme-quickstart-60-seconds
Apr 24, 2026
Merged

README quickstart — first successful API call in 60 seconds#15
IISweetHeartII merged 2 commits intomainfrom
feat/readme-quickstart-60-seconds

Conversation

@IISweetHeartII
Copy link
Copy Markdown
Contributor

Source: backlog.md:58

Improve the README quickstart so new users can reach a first successful AgentGram API call in about 60 seconds.

Restructure the Quick Start section so new users see the shortest
copy-pasteable path (3 lines) to a working API call, with a tip
for the AGENTGRAM_API_KEY env-var flow.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@IISweetHeartII
Copy link
Copy Markdown
Contributor Author

Navi review: REQUEST_CHANGES

blocking:

  • README quickstart가 아직 main branch SDK 동작과 안 맞습니다. 현재 PR head의 src/client.ts는 여전히 AgentGramOptions.apiKey를 필수로 받고(src/client.ts:13-16, :75-79), src/http.ts도 항상 Authorization 헤더를 붙입니다(src/http.ts:48-52).
  • 그런데 README는 AGENTGRAM_API_KEY만 설정하고 new AgentGram()을 호출하면 자동으로 env fallback이 된다고 안내합니다(README.md:44-52). 지금 코드 상태에서는 이 예제가 성립하지 않아서, "60초 안에 첫 성공"이 아니라 잘못된 onboarding 문서가 됩니다.

권장 수정 둘 중 하나:

  1. 이 PR을 env-based init 구현이 들어간 브랜치 위로 rebase/stack해서 문서-동작을 맞추기
  2. 아니면 README에서 env fallback 안내를 빼고, 현재 main 기준으로 실제 동작하는 explicit apiKey quickstart만 남기기

CI green인 건 docs-only라 당연한데, 지금은 사용자를 잘못된 호출로 안내하는 쪽이 더 큰 문제예요.

@IISweetHeartII
Copy link
Copy Markdown
Contributor Author

Navi re-review: APPROVE

  • unsupported env-fallback quickstart가 빠지고, main 기준으로 실제 동작하는 explicit apiKey quickstart만 남아서 이제 문서-동작이 맞습니다.
  • "세 줄 안에 첫 성공" 방향도 유지됐고, onboarding 관점에서 과장 없이 안전한 문서로 정리됐어요.
  • GitHub CI 2개 job success 확인.

Copy link
Copy Markdown
Contributor Author

@IISweetHeartII IISweetHeartII left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed locally: the quickstart now presents the shortest path to a successful first API call and stays consistent with the SDK authentication behavior. No blocking issues found. Note: self-approval is not possible from the author account, so leaving a comment review before merge.

@IISweetHeartII IISweetHeartII merged commit 1c1ad44 into main Apr 24, 2026
2 checks passed
@IISweetHeartII IISweetHeartII deleted the feat/readme-quickstart-60-seconds branch April 24, 2026 06:17
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