From fe71075374bb7741b3fc445952a63a0497fec7a5 Mon Sep 17 00:00:00 2001 From: Perry Byeongchan Park Date: Thu, 23 Jul 2026 14:55:16 +0900 Subject: [PATCH] docs: link the SDK first-app guide --- README.ja.md | 20 +++++++++++++++----- README.ko.md | 20 +++++++++++++++----- README.md | 19 ++++++++++++++----- 3 files changed, 44 insertions(+), 15 deletions(-) diff --git a/README.ja.md b/README.ja.md index 63881bb..48db4c9 100644 --- a/README.ja.md +++ b/README.ja.md @@ -8,6 +8,7 @@ auto-registration、token lifecycle、request signature verification を担当 この repository は実行可能な例として使い、contract と設計原則は SDK 文書を参照してください。 +- [最初のアプリ Quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/quickstart.md) - [アプリ開発完全ガイド](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/app-development.md) - [Function、Extension、WAM、認証の基本概念](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/concepts.md) - [Extension 完全ガイド](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/extensions.md) @@ -62,15 +63,23 @@ transport adapter です。その他の token repository、command registrar、F - App ID、App Secret、Signing Key を持つ開発用 private Channel App アプリがまだない場合は SDK の -[private app 準備手順](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/app-development.md#実装前に-private-app-を準備する) -に従い、app creation、server-side credential storage、minimum permission、endpoint root、 -test channel installation を先に完了してください。 +[最初のアプリ Quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ja/quickstart.md)から +始めてください。Private app creation、server-side credential、minimum permission、endpoint +root、test channel installation を一つの flow で説明します。 **Authentication and permissions** で次の permission を有効にします。 - Channel: `writeGroupMessage` - Manager: `writeGroupMessageAsManager` +## Clone + +```sh +git clone https://github.com/channel-io/app-tutorial.git +cd app-tutorial +corepack enable +``` + ## 環境変数 ```sh @@ -139,5 +148,6 @@ wam/src/contracts.ts TypeScript view と runtime validation wam/src/pages/Send/Send.tsx app/native call 用 WAM SDK hook ``` -この tutorial と旧 Web 文書が異なる場合は、public SDK export、SDK reference、SDK guide、この -実行例の順で確認してください。Go native transport gap は SDK feature-parity 文書で明記します。 +現在の contract は SDK guide と reference で確認し、完全な Go server/WAM implementation は +この repository で確認してください。SDK Quickstart もこの tutorial を参照し、Go native +transport gap は feature-parity 文書で明記します。 diff --git a/README.ko.md b/README.ko.md index 1cc1308..14c69aa 100644 --- a/README.ko.md +++ b/README.ko.md @@ -8,6 +8,7 @@ auto-registration, token lifecycle, request signature 검증을 담당합니다. 이 저장소는 바로 실행할 수 있는 예제로 사용하고 계약과 설계 원칙은 SDK 문서를 확인하세요. +- [첫 앱 만들기 Quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/quickstart.md) - [앱 개발 전체 가이드](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/app-development.md) - [Function, Extension, WAM, 인증 핵심 개념](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/concepts.md) - [Extension 전체 가이드](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/extensions.md) @@ -61,15 +62,23 @@ adapter입니다. 나머지 token repository, command registrar, Function router - App ID, App Secret, Signing Key가 있는 개발용 private Channel App 앱이 아직 없다면 SDK의 -[private app 준비 순서](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/app-development.md#구현-전에-private-app-준비하기)에 -따라 앱 생성, server-side credential 보관, 최소 permission, endpoint root, test channel 설치를 -먼저 완료하세요. +[첫 앱 만들기 Quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/ko/quickstart.md)부터 +따라 하세요. Private app 생성, server-side credential, 최소 permission, endpoint root, test channel +설치를 한 흐름으로 설명합니다. **인증 및 권한** 설정에서 다음 permission을 활성화합니다. - Channel: `writeGroupMessage` - Manager: `writeGroupMessageAsManager` +## Clone + +```sh +git clone https://github.com/channel-io/app-tutorial.git +cd app-tutorial +corepack enable +``` + ## 환경 변수 ```sh @@ -137,5 +146,6 @@ wam/src/contracts.ts TypeScript view와 runtime validation wam/src/pages/Send/Send.tsx app/native call용 WAM SDK hook ``` -이 튜토리얼과 오래된 웹 문서가 다르면 공개 SDK export, SDK reference, SDK guide, 이 실행 예제 -순서로 확인하세요. Go native transport gap은 SDK의 기능 동등성 문서에서 명시합니다. +현재 계약은 SDK guide와 reference에서 확인하고, 완성된 Go server/WAM 구현은 이 저장소에서 +확인하세요. SDK Quickstart도 이 튜토리얼을 연결하며 Go native transport gap은 기능 동등성 +문서에서 명시합니다. diff --git a/README.md b/README.md index 09e4a7a..9ebdca6 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ token lifecycle, and request-signature verification. Use this repository for a runnable end-to-end app. Use the SDK repository for the API contract and design guidance: +- [English first-app quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/quickstart.md) - [English app-development guide](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/app-development.md) - [English concepts: Function, Extension, WAM, and authentication](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/concepts.md) - [English Extension guide](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/extensions.md) @@ -70,14 +71,22 @@ This app pins the latest Go SDK release and exposes the Function and WAM endpoin - Node.js and Yarn 4 through Corepack (for the WAM) - a private Channel App with an App ID, App Secret, and Signing Key -If you do not have an app yet, follow the SDK's -[private-app preparation sequence](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/app-development.md#prepare-a-private-app-before-coding): create a development app, keep credentials server-side, enable the minimum permissions below, prepare endpoint roots, and install it in a test channel. +If you do not have an app yet, start with the SDK's +[first-app quickstart](https://github.com/channel-io/app-sdk/blob/main/docs/guides/en/quickstart.md). It covers private-app creation, server-side credentials, minimum permissions, endpoint roots, and test-channel installation. Enable these permissions in the app's **Authentication and permissions** settings: - Channel: `writeGroupMessage` - Manager: `writeGroupMessageAsManager` +## Clone + +```sh +git clone https://github.com/channel-io/app-tutorial.git +cd app-tutorial +corepack enable +``` + ## Configure ```sh @@ -148,6 +157,6 @@ wam/src/contracts.ts TypeScript view and runtime validation of tha wam/src/pages/Send/Send.tsx WAM SDK hooks for app/native calls ``` -When this tutorial and older web documentation disagree, follow the SDK's public exports, SDK -reference, SDK guides, and this runnable example in that order. The SDK guide links back to this -tutorial and calls out the one native transport gap explicitly. +Use the SDK guides and references for the current contract, and use this repository for its complete +Go server-and-WAM implementation. The SDK quickstart links here and calls out the one native +transport gap explicitly.