Documentation Guide KO - k-p2p-lab/kpl-v3 GitHub Wiki
์ํค ๋ฌธ์ ๊ด๋ฆฌ ์๋ด
Wiki home โบ ํ๊ตญ์ด ๋ฌธ์ ยท ์์ด ์๋ฌธ ยท v3 ๋ฌธ์ ์๋ด
ํ๋ก์ ํธ ๊ณตํต ๋ฌธ์์ v3 ๊ตฌํ ๋ฌธ์์ ๊ธฐ์ค ์์น๋ ์ด ์ํค์ ๋๋ค. ์ด ์ํค ์์์ ํ๋ก์ ํธ ๊ณตํต ๊ฐ๋ ๊ณผ v3 ๊ตฌํ ๊ณ์ฝ์ ํ์ด์ง๋ณ ์ฑ ์์ ๊ตฌ๋ถํฉ๋๋ค.
์ ์ฅ์๋ณ ์ฑ ์
| ์ ์ฅ์ | ๊ด๋ฆฌํ ๋ด์ฉ |
|---|---|
kpl-v3.wiki |
ํ๋ก์ ํธ ๊ฐ๋ , ์ฐ๊ตฌยท์ถํ, ์ด์ยท๊ฐ๋ฐ ์๋ด, ์คํค๋งยท์์, ํ์ ๋ฉ๋ด์ ๋ฌธ์ ์ด๋ฏธ์ง |
kpl-v3 |
์์ค ์ฝ๋, ๋ฐฐํฌ ํ์ผ, ์คํ ์์ , ํ ์คํธ, ๊ธฐ๊ณ๊ฐ ์ฝ๋ ๊ฒ์ฆ ์ ๋ ฅ๊ณผ ์ํค๋ก ์ฐ๊ฒฐํ๋ README |
์ํค ์์์๋ **โ๊ตฌํ์ฒด๊ฐ ๋ฐ๋์ด๋ ์ด ์ค๋ช ์ด ์ ์ง๋๋๊ฐ?โ**๋ก ํ์ด์ง๋ฅผ ๊ตฌ๋ถํฉ๋๋ค. ๊ณตํต ์ค๊ณ ์๋๋ ํ๋ก์ ํธ ํ์ด์ง, ์ํํธ์จ์ด ๋ฆฌ๋น์ ์ ๋ฐ๋ผ ๋ฌ๋ผ์ง๋ ๋์์ v3 ํ์ด์ง์ ๋ก๋๋ค. ๊ฐ์ ๊ณ์ฝ์ ๋ณต์ ํ์ง ์๊ณ ์ฐ๊ฒฐํฉ๋๋ค.
| ์ฃผ์ | ํ๋ก์ ํธ ๊ณตํต ํ์ด์ง | v3 ๊ตฌํ ํ์ด์ง |
|---|---|---|
| ๋ชฉ์ ๊ณผ ๊ธฐ๋ฅ | ์ฐ๊ตฌ ๋ชฉ์ ๊ณผ ์ค๊ณ ์์น | ํ์ฌ ์ง์ ๊ธฐ๋ฅ, ์ค๋น ์ฌํญ๊ณผ ์ ํ |
| ์ํคํ ์ฒ | ์ ์ดยท๋ถ์ฐ ์คํยท๊ด์ธก์ ๊ฐ๋ ์ ๊ด๊ณ | ํ๋ก์ธ์ค, ์๋น์ค, ๋คํธ์ํฌ, ๊ถํ, ์์ํ, ์ฅ์ ๊ฒฝ๊ณ์ ์์ค ์ฐ๊ฒฐ |
| ์ฉ๋๊ณผ ๋ฐฐ์น | ๋ชฉํ ๊ท๋ชจยทํ์ฉ ์ฉ๋ยท๊ด์ธก๋ ์ค๋น ์ํ์ ๊ตฌ๋ถ | CLI ๊ธฐ๋ณธ๊ฐ, Agent๋ณ ์์ธ, ์ค์ผ์ค๋ง ์๊ณ ๋ฆฌ์ฆ, ์ ์ฉ ํ์ธ, ์์ฝ๊ณผ ์ ๋ฆฌ |
| ์คํ ์๋ช ์ฃผ๊ธฐ | ์ค๊ณยท์ฆ๊ฑฐ ์์งยท๋น๊ต์ ๋ณต๊ตฌ ์ด๋ ฅ ๋ณด๊ณ | YAML ๋์, ํ์ด๋ฐ, run/batch ์ํ, ์ ์งยท์ด์ดํ๊ธฐยท์ฌ์๋ |
| ์ธก์ | ๋ชจ์ง๋จ, ๋ถํ์ค์ฑ, ๋จ์์ ๊ณต์ ํ ๋ณด๊ณ ์์น | ์ ํํ ์์, ์ ์ ๋ฒ์ , ์ด๋ฒคํธยทํ๋, ์ง๊ณ์ ์๋ ค์ง ๋๋ฝ |
| ์ด์๊ณผ ์ ๊ทผ | ์ ํํ ๊ตฌํ์ฒด๋ก ์ฐ๊ฒฐ | ๋ฐฐํฌ, ๊ณ์ ยท์ธ์ฆ, ๋ก๊ทธ, SSE, ๋ฌธ์ ์ง๋จ, ๋ฐฑ์ ๊ณผ ๋ณด์กด |
| ๋ถ์๊ณผ ๊ทธ๋ฆผ | ํด์๊ณผ ๋น๊ต ๊ฐ๋ฅ์ฑ์ ๊ธฐ์ค | ๋ถ์ ์์ , ๊ทธ๋ฆผ ์กฐ์, ๋ด๋ณด๋ด๊ธฐ ํ์๊ณผ ์ ์ฅ ํ์ผ |
| ์ด๋ ฅ๊ณผ ์ถํ | ํ๋ก์ ํธ ๋ฐ์ , ๋ ผ๋ฌธ ๋ชฉ๋ก๊ณผ ์ธ์ฉ | ํด๋น ๋ฒ์ ์ ํธํ์ฑ ๋งคํ, ๋ง์ด๊ทธ๋ ์ด์ , ์์ค ๋ชฉ๋ก, ๋ฒค์น๋งํฌ์ ๊ฒ์ฆ ๊ทผ๊ฑฐ |
v3์ v2 ํธํ์ฑ ํ๋ v3 ํธํ์ฑ ํ์ด์ง์, v2 ๋ ผ๋ฌธ์ ์ถํ ํ์ด์ง์ ๋ก๋๋ค. ์ฑ๋ฅ ๊ทผ๊ฑฐ์๋ ๊ตฌํ ๋ฒ์ยท์ ๋ ฅยทํ๊ฒฝยทํ๊ณ๋ฅผ ํจ๊ป ๊ธฐ๋กํฉ๋๋ค.
ํ๋ก์ ํธ ํ์ด์ง
ํ๋ก์ ํธ ๋ชฉ์ ยท๊ฐ๋ ยท์ฐ๊ตฌยท์ถํ์ ์๋ ์ํค ํ์ด์ง์์ ์ง์ ๊ด๋ฆฌํฉ๋๋ค.
| ๋ฌธ์ | ์ฑ ์ |
|---|---|
| ํ๋ก์ ํธ ๊ฐ์ | ์งง์ ํ๋ก์ ํธ ์๊ฐ, ์ฝ๋ ์์, ์ ์ฅ์ ๊ฒฝ๊ณ์ ๋ฒ์ ๋ฐ์ |
| CONCEPTS | ์ค๊ณ ์์น, ๋ ผ๋ฆฌ ์ํคํ ์ฒ, ์ฉ๋๊ณผ ์ํฌ๋ก๋ ๊ฐ๋ |
| RESEARCH | ์ฐ๊ตฌ ์ง๋ฌธ, ์คํ ์ฃผ๊ธฐ, ๋ณด๊ณ ์์น๊ณผ ์ธก์ ๋ฐฐ๊ฒฝ |
| PUBLICATIONS | ํ๋ซํผ ๋ ผ๋ฌธ, ํ์ฉ ์ฐ๊ตฌ์ ์ธ์ฉ ์ง์นจ |
| ์ด ๋ฌธ์ | ํตํฉ ์ํค์ ์ ์ฉํ๋ ์ฑ ์ยท๋ถํ ยทํ์ยท์ ์ง๋ณด์ ๊ธฐ์ค |
์ด์ ์์ ์ ํ์ฌ ์ง์ ๊ธฐ๋ฅ์ v3 ํ์ด์ง์ ๋ก๋๋ค. kpl-v3 README๋ ์ด ์ํค๋ก ์ฐ๊ฒฐํ๋ ์งง์ ์ง์
์ ์
๋๋ค. ์ฐ๊ตฌ ๋ฐฉ๋ฒ๊ณผ ์ถํ ๋ชฉ๋ก์ ๋
์์ ๋ณ๊ฒฝ ์ด์ ๊ฐ ๋ค๋ฅด๋ฏ๋ก ๋ณ๋ ํ์ด์ง๋ก ์ ์งํฉ๋๋ค.
๊ตฌํ์ฒด ๊ตฌ์กฐ
v3 ๋ฌธ์ ์๋ด๋ ๊ตฌํ ๋ฌธ์๋ฅผ ๋ ์์ ์์ ๋ณ๋ก ๋ฌถ์ต๋๋ค.
| ๋ ์์ ์์ | v3 ๊ธฐ์ค ๋ฌธ์ |
|---|---|
| ํ๋ซํผ ์์๊ณผ ์ด์ | Swarm-Deployment, Agent-Capacity, Monitoring |
| ์คํ ์ค๋นยท์คํยท์ ์งยท๋ณต๊ตฌ | Scenario-Library, Experiments; ์คํ ์์ ๋ Churn-Publish-Example |
| ์ค์๊ฐ ๋คํธ์ํฌ ํ์ธ | Dashboard, Topology |
| ์ฆ๊ฑฐ ๋ณด์กดยท๋ถ์ยท๋ด๋ณด๋ด๊ธฐ | Results, Visualization |
| ์ ํํ ๊ณ์ฝ ์กฐํ | Scenario-Reference, Protocol-Options, API, Experiment-Metrics, Bandwidth |
| ๊ตฌํ ์ดํด์ ๋ณ๊ฒฝ | Architecture, Development, Churn-Performance |
| ์ด์ ๊ตฌํ๊ณผ ๋น๊ต | V2-Reproduction, V2-Analysis-Coverage |
Monitoring์ Prometheus/Grafanaยท์ ๊ทผ ๋ก๊ทธยท์ฐ๊ฒฐ ์ง๋จ, Results๋ ์ ์ฅ ํ์ผ๊ณผ ๋ด๋ณด๋ด๊ธฐยท๋ฐฑ์ ๊ฒฝ๊ณ, Experiments๋ ์คํยท๋ณต๊ตฌ๋ฅผ ๋ด๋นํฉ๋๋ค. API๋ HTTP ๋ณธ๋ฌธยท์ํ ์ฝ๋ยทSSE ํ์ยท์บ์ ๊ณ์ฝ, ์งํยท๋์ญํญ ํ์ด์ง๋ ์์, Visualization์ ๊ทธ๋ฆผ ์กฐ์์ ๊ธฐ์ค์ ๋๋ค.
๋ฌธ์๋ฅผ ๋๋๋ ๊ธฐ์ค
๋ ์์ ์์ ์ด๋ ๋ด์ฉ์ ์ฑ ์์ด ๋ฌ๋ผ์ง ๋ ๋ถ๋ฆฌํฉ๋๋ค. ๋จ์ํ ๊ธธ๋ค๋ ์ด์ ๋ก ๋๋๊ฑฐ๋ ๋ฒ๊ทธ ์์ ๋ง๋ค ์ ๋ฌธ์๋ฅผ ๋ง๋ค์ง ์์ต๋๋ค.
- ์ ์ฐจ์ ์ค๋น ์ฌํญ, ๋จ๊ณ, ๊ฒฐ๊ณผ์ ์คํจ ๋์์ ํจ๊ป ๋ก๋๋ค.
- ์ ์ฐจ์ ์ ์ฒด ์คํค๋งยท์์์ ๋ถ๋ฆฌํ๊ณ ํด๋น ์ฐธ์กฐ ์ ๋ก ์ฐ๊ฒฐํฉ๋๋ค.
- ์ค์๊ฐ ๊ด์ธก, ์๋ณธ ์ ์ฅ ๊ฒฐ๊ณผ, ๊ณ์ฐํ ๋ถ์, ๋ชจ๋ํฐ๋ง ์ด๋ ฅ์ ๋ณด์กด ๊ธฐ๊ฐ์ด ๋ค๋ฅด๋ฏ๋ก ๊ตฌ๋ถํฉ๋๋ค.
- ๋น๊ตํ๋ฉฐ ์ฝ์ด์ผ ํ๋ ํ๋กํ ์ฝ ์ต์ ๊ณผ ์งํ ์ ์๋ ๊ด๋ จ ํญ๋ชฉ์ ํจ๊ป ๋ก๋๋ค.
- ์ต์ ํ ์ธก์ ๊ณผ ๊ณผ๊ฑฐ ๊ฒ์ฆ ๊ทผ๊ฑฐ๋ ๋ ์งยท์ ๋ ฅยทํ๊ณ์ ํจ๊ป ๊ฐ๋ฐยทํธํ์ฑ ์๋ฃ์ ๋ก๋๋ค. ์ดํ checkout์ ๊ฒ์ฆ์ผ๋ก ํํํ์ง ์์ต๋๋ค.
ํ์๊ณผ ์ ์ง๋ณด์
์์ด ๋ฌธ์๋ฅผ ๊ธฐ์ค์ผ๋ก ํฉ๋๋ค. Home.md๊ฐ ๊ธฐ๋ณธ ์ง์
์ ์ด๋ฉฐ ๊ธฐ๋ณธ ์ฌ์ด๋๋ฐยท๋ชฉ์ฐจยทFooter๋ ์์ด๋ก ๊ตฌ์ฑํฉ๋๋ค. _Sidebar.md์ ํ๊ตญ์ด ๋ฌธ์๋ ๊ธฐ๋ณธ์ ์ผ๋ก ์ ํ ํ์ ์น์
์ด๊ณ , Home-KO.md๋ ํ๊ตญ์ด ๋ฒ์ญ์ ๋ชจ์ ๋ณด๋ ์ง์
์ ์
๋๋ค. ์์ด ํ์ด์ง ํ๋จ์๋ ํ๊ตญ์ด ๋ฒ์ญ ๋งํฌ๋ฅผ, ํ๊ตญ์ด ํ์ด์ง ์๋จ์๋ ํ๊ตญ์ด ๋ฌธ์ ์น์
๊ณผ ํด๋น ์์ด ์๋ฌธ ๋งํฌ๋ฅผ ๋ก๋๋ค.
Agent-Capacity.md์ Agent-Capacity-KO.md์ฒ๋ผ ํํํ๊ณ ์์ ์ ์ธ ASCII ํ์ด์ง ์ด๋ฆ์ ์ฌ์ฉํฉ๋๋ค. ํ๊ตญ์ด ํ์ ์น์
์ ํ์ ๊ตฌ์กฐ๋ก ๊ตฌ์ฑํ์ฌ ๊ธฐ์กด ํ์ด์ง URL์ ์ ์งํฉ๋๋ค. ์์ด ์๋ฌธ์ ๋จผ์ ๊ฐฑ์ ํ๊ณ ํ๊ตญ์ด์ ์ ๋ฒ์ยท์์ ยท๋์์ ๋ง์ถฅ๋๋ค. ํ๊ตญ์ด ์๋ด์์๋ ์ค์ ์์ด UI ๋ ์ด๋ธ์ ์ ์งํฉ๋๋ค.
Markdown ๋งํฌ๋ .md ์๋ ์ ์ฒด ์ํค URL์ ์ฌ์ฉํฉ๋๋ค. ์: [Agent ์ฉ๋](https://github.com/k-p2p-lab/kpl-v3/wiki/Agent-Capacity-KO). ํธ์ง ์ ์ ์ต์ปค๋ฅผ ๋ณด์กดํฉ๋๋ค. ์์คยท๋๋ ํฐ๋ฆฌยท์์ ๋งํฌ๋ kpl-v3 ์ ์ฅ์์ blob/tree URL์ ์ฌ์ฉํฉ๋๋ค. ๋ก์ปฌ ../internal ๊ฒฝ๋ก๋ ์ํค ์ ์ฅ์๋ฅผ ๊ธฐ์ค์ผ๋ก ํด์๋์ด v3 ์์ค๋ฅผ ๊ฐ๋ฆฌํฌ ์ ์์ต๋๋ค. ์ํค ์ด๋ฏธ์ง๋ images/์ ๋๊ณ raw ์ํค URL๋ก ์ฐ๊ฒฐํฉ๋๋ค.
์ฝ๋ ๋์์ด ๋ฐ๋๋ฉด ํด๋น ์ํค ํ์ด์ง์ ํ๊ตญ์ด ์์ ๊ด๋ จ ์์ค ๋ฆฌ๋น์ ์ ๋ง์ถฐ ๊ฐฑ์ ํฉ๋๋ค. ํ์ด์ง๋ฅผ ์ถ๊ฐยท๋ณ๊ฒฝํ ๋ Homeยท๋ชฉ์ฐจยทSidebar๋ฅผ ํจ๊ป ๋ง์ถฅ๋๋ค. kpl-v3 README๋ ์งง์ ์ง์
์ ์
๋๋ค. ๋ฌธ์์ ์ด๋ฏธ์ง๋ ์ํค์ ๋๊ณ v3์ docs ๋๋ ํฐ๋ฆฌ๋ฅผ ๋ค์ ๋ง๋ค์ง ์์ต๋๋ค.
๋ก์ปฌ ํธ์ง๊ณผ ๊ฒ์ฆ
๋ก์ปฌ์์ ์์ ํ ๋ ์ํค๋ฅผ ๋ณ๋๋ก cloneํฉ๋๋ค.
git clone https://github.com/k-p2p-lab/kpl-v3.wiki.git
cd kpl-v3.wiki
์ด๊ณณ์์๋ Markdown ํ์ด์ง๋ฅผ ์์ ํฉ๋๋ค. ์ ํ๋ฆฌ์ผ์ด์
ยทSwarmยท๊ฐ๋ฐ ๋ช
๋ น์ kpl-v3 ์์ค ์ ์ฅ์์์ ์คํํฉ๋๋ค. ์ํค๋ ๋ฌธ์ ์ ์ฅ์์ด๋ฉฐ ์ ํ๋ฆฌ์ผ์ด์
checkout์ด ์๋๋๋ค. ์ํค์ v3์ commit ์ด๋ ฅ์ ๋
๋ฆฝ์ ์ด๋ฏ๋ก ๋ฒค์น๋งํฌยท๊ฒ์ฆ ๊ทผ๊ฑฐ๋ฅผ ๋จ๊ธธ ๋ ์์ค commit์ ๊ธฐ๋กํฉ๋๋ค.
๊ฒ์ ์ ์ ํ์ด์งยท์ต์ปค, ๊ฐ์ ์ธ์ด ์ฐ๊ฒฐ, ์์ค ํ์ผยท์ด๋ฏธ์ง, Sidebarยท๋ชฉ์ฐจ์์์ ์ ๊ทผ, ํยท์ฝ๋ ํ์คยท๊ตฌ์กฐํ ์์ ๋ฅผ ๊ฒ์ฌํฉ๋๋ค. ๋ฌธ์ ๊ฒ์ฌ๋ ์คํ ๋์์ ๊ฒ์ฆํ์ง ์์ผ๋ฉฐ ๊ณผ๊ฑฐ ํ ์คํธ๋ฅผ ์ดํ ๋ฆฌ๋น์ ์์ ์ํํ ๊ฒ์ผ๋ก ํ์ํ์ง ์์ต๋๋ค.
GitHub ๊ณต์ ๋ฌธ์์ ์ํค ๋งํฌยท์ด๋ฏธ์ง, SidebarยทFooter ํ์ผ, ์ ์ ์ ์๋ ์น์ , ์ํค Git ํธ์งยท๊ฒ์๋ฅผ ์ฐธ๊ณ ํ์ญ์์ค.
์ด์ ๊ธฐ๋ก
์ ์ฅ์ ์๊ฐ์ v3 ๋ชฉ์ฐจ๋ฅผ ํฌํจํ Markdown 56๊ฐ(์๋ฌธยท๊ตญ๋ฌธ 28์)๋ฅผ ์ด์ํ์ต๋๋ค. ์ด์ ๋ชฉ๋ก์ ์๋ณธ ๊ฒฝ๋กยท๋ด์ฉ hashยท์ํค ๋์ยท์์ค ๋ฆฌ๋น์ ์ ๊ธฐ๋กํฉ๋๋ค. ์๋๋ ์ด์ ๊ธฐ์ค์ด๋ฉฐ ํ์ฌ ์ ํ๋ฆฌ์ผ์ด์ ๋ฆฌ๋น์ ์ ๋ปํ์ง ์์ต๋๋ค.
| ์๋ณธ | ์ด์ ๊ธฐ์ค |
|---|---|
| ์ด์ ํ๋ก์ ํธ ์ ์ฅ์ | b399b16f3a520692aa64ec282eb21f86c2cb1538 |
| v3 | c20624ac6d21 |
์ด์ Hub ์ ์ฅ์๋ ํ์ง ๋์์ผ๋ก ๋๋ฉฐ ๋ฌธ์ยท๋ก๊ณ ยท๋์์ ์ด ์ํค์์ ๊ด๋ฆฌํฉ๋๋ค. v3์ docs๋ ์ด๋ ์๋ด์ ์ํคํ
์ฒ ์ด๋ฏธ์ง๋ฅผ ํฌํจํด ์ ๊ฑฐํ์ต๋๋ค. ์ด์ ๋ชฉ๋ก์ ์ด์ ๊ฒฝ๋กยท๋ฆฌ๋น์ ์ ์ถ์ฒ ์๋ณ์์ด๋ฉฐ ์ด์ ์ ์ฅ์์ ์ ๊ทผํ ํ์๊ฐ ์์ต๋๋ค. ์ดํ ๋ฌธ์ ๋ณ๊ฒฝ์ ์ํค Git ์ด๋ ฅ์ผ๋ก ๊ด๋ฆฌํฉ๋๋ค. v2 ๊ฐ์ฌ manifest๋ ๊ฐ์ฌ ์คํฌ๋ฆฝํธ๊ฐ ์ฝ๋ ์
๋ ฅ์ด๋ฏ๋ก v3์ scripts/data/v2-analysis-coverage.json์ผ๋ก ์ฎ๊ฒจ ์ฝ๋์ ํจ๊ป ๋ฒ์ ๊ด๋ฆฌํฉ๋๋ค. ์ค๋ช
์ฉ ๋ถ์ ๋ฒ์ ํ์ด์ง๋ ์ํค์ ์์ต๋๋ค.
์ด์ ๋ชฉ๋ก์ wikiAssets๋ ๋ก๊ณ ยท์ํคํ
์ฒ PNG์ ์๋ณธ ๊ฒฝ๋ก, ์ํค ๊ฒฝ๋ก์ SHA-256์ ๊ธฐ๋กํฉ๋๋ค. ๊ฐ๋
ยท์คํ ์ฃผ๊ธฐยท๊ตฌํ ๋์์ Mermaid ์๋ณธ๋ ํด๋น ์ํค ํ์ด์ง์ ๋ณด์กดํฉ๋๋ค.