Skip to content

docs(all demos): add "Get just this demo" — per-folder clone instructions#65

Merged
jlc488 merged 1 commit into
mainfrom
docs/per-demo-clone-instructions
Jun 1, 2026
Merged

docs(all demos): add "Get just this demo" — per-folder clone instructions#65
jlc488 merged 1 commit into
mainfrom
docs/per-demo-clone-instructions

Conversation

@jlc488

@jlc488 jlc488 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

What / 무엇

Adds a "Get just this demo" section to every demo's README (README.md + README.ko.md, all 20 demos / 40 files), showing how to fetch a single demo folder instead of cloning the whole repo.

모든 데모 README(README.md + README.ko.md, 20개 데모 / 40파일)에 "이 데모만 받기" 섹션 추가 — 저장소 전체를 clone하지 않고 데모 한 폴더만 받는 방법.

Why / 왜

Each demo is a standalone Gradle project (own settings.gradle.kts + gradlew), but the READMEs only documented cloning the entire devslab-examples repo. Readers who want one demo had no copy-paste path.

각 데모는 독립 Gradle 프로젝트인데, README는 전체 repo clone만 안내했음. 데모 하나만 원하는 사용자를 위한 복붙 경로가 없었음.

How / 어떻게

Two methods per demo, parameterized to that demo's folder:

  • git sparse checkoutclone --filter=blob:none --sparse then git sparse-checkout set <demo> (keeps history, downloads only that folder)
  • tarball (no git)curl … main.tar.gz | tar -xz --strip-components=2 devslab-examples-main/<demo> (folder only, no .git)

Placed right after Prerequisites (or just before the Run heading for the few demos without a Prerequisites section), so the flow reads get → run.

Verification / 검증

  • All 40 files contain the block; each references its own demo directory (verified by script — no cross-wired folder names).
  • Docs-only change; no code touched.

… one-folder fetch

Every demo here is a standalone Gradle project, but the READMEs only told readers to
clone the whole devslab-examples repo. Add a short "Get just this demo" section to all
20 demos (README.md + README.ko.md, 40 files) showing two ways to grab a single demo
folder:

- git sparse checkout: clone --filter=blob:none --sparse, then
  `git sparse-checkout set <demo>` — keeps git history, downloads only that folder.
- tarball (no git): curl the main tarball piped through
  `tar -xz --strip-components=2 devslab-examples-main/<demo>` — folder only, no .git.

Placed right after Prerequisites (or before the Run heading for the few demos that have
no Prerequisites section), so the flow reads get -> run. Each block is parameterized to
its own folder name; verified all 40 files reference the correct demo directory.
@jlc488 jlc488 merged commit dd8fd00 into main Jun 1, 2026
22 checks passed
@jlc488 jlc488 deleted the docs/per-demo-clone-instructions branch June 1, 2026 14:38
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