diff --git a/README.md b/README.md
index e011ab56..782ca9aa 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,7 @@
-![Sprint 33](https://github.com/user-attachments/assets/2b23184d-90ed-458d-9dc4-dab9579c1e48)
-
+[![Sprint 33](https://github.com/user-attachments/assets/2b23184d-90ed-458d-9dc4-dab9579c1e48)](https://octodocs.site)
-
-
-
-
-
-
-
![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fboostcampwm-2024%2Fweb15-OctoDocs&count_bg=%23000000&title_bg=%23000000&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false) [![Group 112 (1)](https://github.com/user-attachments/assets/b7b4387e-ffe9-4469-82b7-c14509282d86)](https://octodocs.site)
@@ -17,12 +9,28 @@
-# ๐ ํ๋ก์ ํธ ์๊ฐ
+
+ ๐ ์ฅํ ๋
์ค ์๊ฐ
+ ๐ฑ ์ฃผ์ฐจ๋ณ ํผ๋๋ฐฑ์ ํตํ ์ ์ง์ ๊ฐ์
+ ๐บ๏ธ ํ๋ก์ ํธ ํ์๋ผ์ธ
+ ๐ ๏ธ ํ๋ก์ ํธ ๊ตฌ์กฐ
+ ๐ง ๋ฌธ์ ์ ํด๊ฒฐ๊ณผ์
+ ๐งธ ํ์ ์๊ฐ
+
+
+
+
+๐ ์ฅํ ๋
์ค ์๊ฐ
+
+![Group 117 (2)](https://github.com/user-attachments/assets/04e39b34-9483-4896-bd6b-6456c4784eee)
+
+
### ๐ธ๏ธ ๊ด๊ณํ ์ง์ ๊ด๋ฆฌ ํด
-> ๋ฌธ์๋ค์ ์์ฑํ๊ณ ์ฐ๊ฒฐํ๋ฉด์ ๋ฌธ์๋ค ๊ฐ์ ์ฐ๊ด ๊ด๊ณ๋ฅผ ์๊ฐ์ ์ผ๋ก ํ์ธ ๊ฐ๋ฅ.
+๐ฑ ๋งํฌ๋ค์ด, ์ด๋ฏธ์ง, ์ฝ๋ ๋ฑ์ ํ์ฉํด์ ๊ฐํธํ๊ฒ **๋ฌธ์ ์์ฑ**์ด ๊ฐ๋ฅํฉ๋๋ค.
+๐ฑ ์์ฑํ ๋ฌธ์๋ค์ **์ฐ๊ฒฐ**ํ๊ณ **๋ฐฐ์น**ํ๋ฉด์ ์๋ก์ด ์์ด๋์ด๋ฅผ ์ฝ๊ฒ ๋ ์ฌ๋ฆด ์ ์์ต๋๋ค.
https://github.com/user-attachments/assets/1ac81d56-a0ce-403c-9e3f-7ba092b6a5b6
@@ -32,68 +40,220 @@ https://github.com/user-attachments/assets/1ac81d56-a0ce-403c-9e3f-7ba092b6a5b6
### ๐งธ ์ค์๊ฐ ๋์ ํธ์ง ๋ฐ ํ์
๊ธฐ๋ฅ
-> ์ค์๊ฐ์ผ๋ก ๋ค๋ฅธ ์ฌ์ฉ์๋ค๊ณผ ๋์ ํธ์ง ๋ฐ ํ์
๊ฐ๋ฅ.
+๐ฑ ์๋ํฐ์์ ๊ฐํธํ๊ฒ **์ค์๊ฐ ๋์ ํธ์ง**์ด ๊ฐ๋ฅํฉ๋๋ค.
+๐ฑ ์์ฑ๋ ๋ฌธ์๋ค๋ **ํจ๊ป ์ฐ๊ฒฐํ๊ณ ๋ฐฐ์น**ํด ๋ณด๋ฉฐ ์ฐ๋ฆฌ ํ๋ง์ ๊ตฌ์กฐ๋ฅผ ๋ง๋ค์ด ๋ณผ ์ ์์ต๋๋ค.
+
+
+https://github.com/user-attachments/assets/86b0dcaf-3640-4836-8b91-207b39b17b05
-https://github.com/user-attachments/assets/ad1f6dc9-50af-46e4-bac4-267b1432b301
### โบ๏ธย ์ํฌ์คํ์ด์ค ์ด๋ ๊ธฐ๋ฅ
-> ๊ฐ๋ณ ์ํฌ ์คํ์ด์ค์ ๋ค๋ฅธ ์ฌ์ฉ์๋ค์ ์ด๋ํด์ ํจ๊ป ์ด์ฉ ๊ฐ๋ฅ.
+๐ฑ ์ฐ๋ฆฌ ํ๋ง์ **์ํฌ ์คํ์ด์ค๋ฅผ ์์ฑ**ํ๊ณ ํ์๋ค์ **์ด๋**ํ ์ ์์ต๋๋ค.
+๐ฑ ์ํฌ ์คํ์ด์ค์ **๊ณต๊ฐ ๋ฒ์**๋ฅผ ์ค์ ํด์ ๋๊ตฌ๋ ์ฐธ์ฌํ ์ ์๋ ๊ณต๊ฐ๋ ์์ฑ์ด ๊ฐ๋ฅํฉ๋๋ค.
+
+
+https://github.com/user-attachments/assets/0c096e40-bed4-4cee-bb8e-40f72a5d43f2
+
+
+
+
+
+๐ฑ ์ฃผ์ฐจ๋ณ ํผ๋๋ฐฑ์ ํตํ ์ ์ง์ ๊ฐ์
+
+
+
+> Octodocsํ์ **์ ์์ผํ ๊ฐ๋ฐ**์ ์ต์ฐ์ ๋ชฉํ๋ก ์ผ๊ณ , ์ด๋ฅผ ํ์ ์๊น๋ก ์๋ฆฌ์ก๊ฒ ํ์ต๋๋ค. ๋ถ์คํธ์บ ํ์ผ ๋ง๋ก ์ฃผ์ฐจ๋ณ๋ก ๊ณ ์ ํ
์คํฐ๋ฅผ ํ๋ณดํ ์ ์๊ณ , ์ด๋ฅผ ํตํด **์ด์๊ณผ ๊ฐ๋ฐ์ ๊ฒฝํ**์ ํด๋ณผ ์ ์๋ ์ต์ ์ ํ๊ฒฝ์ด๋ผ๊ณ ์๊ฐํ๊ธฐ ๋๋ฌธ์ธ๋ฐ์. ๋น ๋ฅธ ๋ฐฐํฌ ํ ๋งค์ฃผ ๋ค์ํ ํผ๋๋ฐฑ์ ๋ฐ์์ค๋ฉฐ ๋ฌธ์ ๋ฅผ ํด๊ฒฐํ๊ณ ๊ฐ์ ํด ๋๊ฐ๋ ๊ณผ์ ์ ์ง์ ํ์ธํด๋ณด์ธ์!
+
+
+
+### 3์ฃผ์ฐจ ํผ๋๋ฐฑ ๋ฐ์
+
+โ [๐ย 3์ฃผ์ฐจ ์ ์ฒด ์ฌ์ฉ์ ํผ๋๋ฐฑ ๋ฐ์ ๊ธฐ๋ก ๋ณด๋ฌ๊ฐ๊ธฐ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/3%EF%B8%8F%E2%83%A3-3%EC%A3%BC%EC%B0%A8-%EC%82%AC%EC%9A%A9%EC%9E%90-%ED%94%BC%EB%93%9C%EB%B0%B1-%EB%B0%98%EC%98%81-%EA%B8%B0%EB%A1%9D)
+
+![image 23](https://github.com/user-attachments/assets/a566ce1e-b2ab-4690-80a0-3189613debc2)
+
+
+๐๐ปย **๋ณด๋๋, ๋ฌธ์๋
ธ๋์ ๋ง์ฐ์ค ํฌ์ธํฐ๊ฐ ๋ฌ๋์ผ๋ฉด ์ข๊ฒ ์ด์.**
+
+โ โ
ย ์บ๋ฒ์ค์์ ๋ง์ฐ์ค๋ฅผ ์์ง์ด๋ ์ค์ธ ์ ์ ๋ค์ ์ปค์๋ฅผ ๋ณด์ฌ์ฃผ๊ณ , ์ ์ ๋ ์์ ์ **์ปค์ ์๊น์ ์ปค์คํ
**ํ ์ ์๋ ๊ธฐ๋ฅ์ ์ถ๊ฐํ์ต๋๋ค. [PR ๋งํฌ](https://github.com/boostcampwm-2024/web15-OctoDocs/pull/219)
+
+
+
+๐๐ป **์ฐ๊ฒฐ๊ฐ์๊ฑฐ ํ๋ค๋ณด๋ฉด ๋ณต์กํด์ง๋ค์**
+
+โ โ
์ฃ์ง๋ค์ด ์์ผ๋ณด์ด๋ ๊ฒ์ด ๋ฌธ์ ์ ์ด๋ผ๊ณ ํ๋จํ๊ณ ์ฃ์ง์ ์์์ ๊ณผ ๋์ ์ด ํญ์ **์ต๋จ ๊ฒฝ๋ก**๊ฐ ๋๊ฒ ํ๋ ๊ธฐ๋ฅ์ ์ถ๊ฐํ์ต๋๋ค. [PR ๋งํฌ](https://github.com/boostcampwm-2024/web15-OctoDocs/pull/201)
+๐๐ป **์คํฌ๋ฆฐ ๋์ด๋ฅผ ์๊ฒ ํ ์ํ์์ ์ผ์ชฝ ์ฌ์ด๋๋ฐ๊ฐ ๋ฒํผ UI๋ฅผ ๊ฐ๋ ค๋ฒ๋ ค์ฉ**
+
+โ โ
์ฌ์ด๋๋ฐ UI๋ฅผ ์์ , **์ฌ์ด๋๋ฐ๋ฅผ ๋ซ์ ์ ์๋ ๊ธฐ๋ฅ**์ ์ถ๊ฐํ์ต๋๋ค. [PR ๋งํฌ](https://github.com/boostcampwm-2024/web15-OctoDocs/pull/228)
+
+
+
+### 4์ฃผ์ฐจ ํผ๋๋ฐฑ ๋ฐ์
+
+โ [๐ย 4์ฃผ์ฐจ ์ ์ฒด ์ฌ์ฉ์ ํผ๋๋ฐฑ ๋ฐ์ ๊ธฐ๋ก ๋ณด๋ฌ๊ฐ๊ธฐ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/4%EF%B8%8F%E2%83%A3-4%EC%A3%BC%EC%B0%A8-%EC%82%AC%EC%9A%A9%EC%9E%90-%ED%94%BC%EB%93%9C%EB%B0%B1-%EB%B0%98%EC%98%81-%EA%B8%B0%EB%A1%9D)
-# ๐ ๏ธย ํ๋ก์ ํธ ๊ตฌ์กฐ
+
+![Group 115 (1)](https://github.com/user-attachments/assets/1da2266f-247a-43ba-9b75-b7e4f7129b30)
+
+๐๐ป **ํ
๋๋ฆฌ๊ฐ ๋ ๋๊บผ์์ ์๋ํฐ๋ ์๋์ ๊ธฐ๋ณธ ๋ฐฐ๊ฒฝ์ด ๋ ๊ตฌ๋ถ์ด ์ ๋์์ผ๋ฉด ์ข๊ฒ ์ด์! ์์์ ๋ณ๊ฒฝํ ์ ์์ผ๋ฉด ์ข๊ฒ ์ต๋๋ค!**
+
+โ โ
๋
ธ๋์ ์๊น์ ์ฌ์ฉ์๊ฐ ๊ฒฐ์ ํ ์ ์์ผ๋ฉด ๊ณตํต์ ์ธ ๋ฌธ์ (๋
ธ๋๊ฐ ๋ฐฐ๊ฒฝ์ผ๋ก๋ถํฐ ๋ถ๋ฆฌ๋์ด ๋ณด์์ผ๋ฉด ์ข๊ฒ ๋ค)๊ฐ ํด๊ฒฐ๋๋ค๊ณ ํ๋จํ๊ณ ย **๋
ธ๋์ ์๊น์ ์ปค์คํ
**ํ ์ ์๋ ๊ธฐ๋ฅ์ ์ถ๊ฐํ์์ต๋๋ค.ย [PR ๋งํฌ 1(FE)](https://github.com/boostcampwm-2024/web15-OctoDocs/pull/201)ย [PR ๋งํฌ 2(BE)](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/4%EF%B8%8F%E2%83%A3-4%EC%A3%BC%EC%B0%A8-%EC%82%AC%EC%9A%A9%EC%9E%90-%ED%94%BC%EB%93%9C%EB%B0%B1-%EB%B0%98%EC%98%81-%EA%B8%B0%EB%A1%9D)
+
+
+
+๐๐ป **favicon์ ๋ฌธ์ด ๋ฃ์ด์ฃผ์ธ์ ๋ฌธ์ด ๊ท์ฌ์์...**
+
+โ โ
ํ์ฌ ๋ฐฐํฌ๋ ์ฌ์ดํธ [**https://octodocs.site**](https://octodocs.site/)๋ฅผ ํตํด ํ์ธํ ์ ์์ต๋๋ค.
+
+
+
+๐๐ป **์ฌ์ฉ์ ํ๋กํ (์ด๋ฆํ๊ณ ์๊น) ๋ณ๊ฒฝํ๋ ๊ธฐ๋ฅ์ด ์ ๋์ ์ ๋์ด์. ์ฌ์ฉํ๊ธฐ ์ฌ์ ์ผ๋ฉด ์ข๊ฒ ์ต๋๋ค.**
+
+โ โ
ย ํ๋กํ์ ๋ณ๊ฒฝํ ์ ์๋ ๋ฒํผ์ ๋์ ๋๋ ๊ณณ์ ์๋ก ์์ฑํ ํ, ์ฌ์ฉ์๊ฐ ๋ณธ์ธ์ ์ปค์๋ฅผ ์ง์ ๋ณด๊ณ ์ฒดํํ ์ ์๋ **์ปค์ ํ๋ฆฌ๋ทฐ ๊ธฐ๋ฅ**์ ์ถ๊ฐํ์ต๋๋ค.ย [PR ๋งํฌ](https://github.com/boostcampwm-2024/web15-OctoDocs/pull/274)
+
+
+
+### 5์ฃผ์ฐจ ํผ๋๋ฐฑ ๋ฐ์
+
+![แแ
ณแแ
ณแ
แ
ตแซแแ
ฃแบ 2024-12-03 แแ
ฉแแ
ฎ 8 09 51 1](https://github.com/user-attachments/assets/74d02bff-e476-425c-8086-a377aa2cb482)
+
+
+
+๐จย **๋ฐ๋ชจ ์ค ์๋น์ค๊ฐ ๋ค์ด๋๋ ๋ฌธ์ ๊ฐ ๋ฐ์ํ์ด์**
+
+> 5์ฃผ์ฐจ์๋ ๋ฐ๋ชจ ๋ฐํ ์ค ์ฌ์ฉ์์ ํธ๋ํฝ์ด ๋ชฐ๋ฆฌ๋ฉด์ ์์ํ์ง ๋ชปํ๋ ๋ฒ๊ทธ๋ก ์ธํด ์๋ฒ๊ฐ ๋ค์ด๋์์ต๋๋ค. ์ด๋ํ **์ค์ฌ์ฉ์๋ก๋ถํฐ ์จ** ์ค์ํ ํผ๋๋ฐฑ์ด๋ผ๊ณ ์๊ฐํ์๊ณ ๋ค๋ฅธ ํผ๋๋ฐฑ๋ณด๋ค ์๋น์ค ๋ณต๊ตฌ๋ฅผ ์ต์ฐ์ ๊ณผ์ ๋ก ์ผ์์ต๋๋ค. ์ด ๊ณผ์ ์์ ์ด๋ค ๋ฌธ์ ๊ฐ ์์๊ณ ์ด๋ฅผ ์ด๋ป๊ฒ ํด๊ฒฐํ์๊น์?
+>
+
+โ [๐ย ์ด? ๊ธ์ง, ๋ชจ๋ํฐ ์์ 3๋ช
์ด์ ์์๊ธฐ ๊ธ์ง](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/5%EF%B8%8F%E2%83%A3-5%EC%A3%BC%EC%B0%A8-%EB%B2%84%EA%B7%B8-%EA%B8%B0%EB%A1%9D)
+
+
+
+๐บ๏ธ ํ๋ก์ ํธ ํ์๋ผ์ธ
+
+![Overview-variant (18)](https://github.com/user-attachments/assets/a503f8fe-bab9-4cf3-8d9d-98ff43ab0c3e)
+
+
+
+
+
+๐ ๏ธ ํ๋ก์ ํธ ๊ตฌ์กฐ
### ๐ฅ๏ธย System Architecture
-![image (13)](https://github.com/user-attachments/assets/60bfb7a1-3c1a-436d-b961-5a30dc9dba7f)
+![image (13)](https://github.com/user-attachments/assets/bee51119-c814-4f57-8cda-60ea4bfdd2dd)
+
### ๐ณย Sequence Diagram
-
+```mermaid
+sequenceDiagram
+ participant Subscriber as ๊ตฌ๋
์
+ participant OctoDocs as OctoDocs ์ํฌ์คํ์ด์ค
+ participant Yjs as yjs ๋ผ์ด๋ธ๋ฌ๋ฆฌ
+ participant YSocket as y-socketIO provider
+ participant WS_Server as websocket server (ysocketio)
+ participant PageModule as page ๋ชจ๋ (node ๋ชจ๋)
+ participant Redis as redis
+ participant Postgres as postgres
+ %% ์น์์ผ ์ฐ๊ฒฐ ํ๋ก์ฐ
+ note over Subscriber, YSocket: [์น์์ผ ์ฐ๊ฒฐ ํ๋ก์ฐ]
+ Subscriber->>OctoDocs: Y.Doc ์์ฑ ์์ฒญ
+ OctoDocs->>Yjs: Y.Doc ์์ฑ ์ํ
+ Yjs->>YSocket: Y.Doc ๊ณต์ ์์ฒญ
+ alt [Y.Doc์ด ์กด์ฌํ์ง ์์ ๋]
+ YSocket->>WS_Server: ์น์์ผ ์ฐ๊ฒฐ
+ WS_Server->>PageModule: ๋ฐ์ดํฐ ์กฐํ ์์ฒญ
+ PageModule->>Redis: ๋ฐ์ดํฐ ์กฐํ ์์ฒญ
+ Redis->>PageModule: ๋ฐ์ดํฐ ์กฐํ ์๋ต
+ PageModule->>WS_Server: ๋ฐ์ดํฐ ์กฐํ ์๋ต
+ WS_Server->>YSocket: Y.Doc์ ์ด๊ธฐ ๋ฐ์ดํฐ ์
ํ
+ YSocket->>Yjs: ์น์์ผ ์ฐ๊ฒฐ ์๋ฃ
+ else [Y.Doc์ด ์กด์ฌํ ๋]
+ YSocket->>WS_Server: ์น์์ผ ์ฐ๊ฒฐ
+ YSocket->>Yjs: ์น์์ผ ์ฐ๊ฒฐ ์๋ฃ
+ end
+ %% ํ์ด์ง ์ ๋ณด ๋ณ๊ฒฝ ํ๋ก์ฐ
+ note over OctoDocs, WS_Server: [ํ์ด์ง ์ ๋ณด ๋ณ๊ฒฝ ํ๋ก์ฐ]
+ OctoDocs->>Yjs: Y.Doc ๋ฐ์ดํฐ ๋ณ๊ฒฝ
+ Yjs->>YSocket: ๋ณ๊ฒฝ๋ ๋ฐ์ดํฐ ์ ๋ฌ
+ YSocket->>WS_Server: ์์ผ ์์ฒญ
+ WS_Server->>PageModule: ์์ผ ์์ฒญ
+ PageModule->>Redis: ๋ณ๊ฒฝ ์ฌํญ ์ ์ฅ
+ Redis->>PageModule: ๋ณ๊ฒฝ ์ฌํญ ์ ์ฅ ์๋ฆผ
+ PageModule-->>WS_Server: ์ ์ฅ ์๋ฃ ์๋ฆผ
+ WS_Server-->>YSocket: ๋ณ๊ฒฝ๋ ๋ฐ์ดํฐ ์ ๋ฌ
+ YSocket-->>Yjs: ๋ชจ๋ ์ฐธ์ฌ์๋ค์๊ฒ Y.Doc ๋ฐ์ดํฐ ๋ณ๊ฒฝ
+ %% ๋ฐ์ดํฐ๋ฒ ์ด์ค ์์ํ ํ๋ก์ฐ
+ note over Redis, Postgres: [๋ฐ์ดํฐ๋ฒ ์ด์ค ์์ํ ํ๋ก์ฐ]
+ loop [์ค์ผ์ค๋ฌ]
+ Redis->>Postgres: ๋ณ๊ฒฝ ์ฌํญ ์ ์ฅ
+ Postgres->>Redis: ๋ณ๊ฒฝ ์ฌํญ ์ ์ฅ ์๋ฆผ
+ end
+```
+
+
+
+
+
๐ง ๋ฌธ์ ์ ํด๊ฒฐ๊ณผ์
+
+### ๐ ์ค์๊ฐ ํธ์ง ๊ตฌํ ๊ณผ์
+
+์ค์๊ฐ์ผ๋ก ์ฌ๋ฌ ์ฌ์ฉ์๊ฐ ๋์ผํ ๋ฌธ์๋ฅผ ํธ์งํ ๋, ์ถฉ๋ ์์ด ๋๊ธฐํํ๋ ๊ฒ์ ์ด๋ ค์ด ๋ฌธ์ ์
๋๋ค. Octodocs ํ์ ์ด๋ฅผ ์ง์ ๊ตฌํํ๋ ๋์ **YJS**์ **Socket.IO**๋ฅผ ๊ฒฐํฉํ๋ ์ ๋ต์ ์ ํํ์ต๋๋ค. ํ์ง๋ง ์ด ๋ ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ํตํฉํ๋ ๊ณผ์ ์์ ์์์น ๋ชปํ ๋ฌธ์ ๋ค์ ์ด๋ป๊ฒ ํด๊ฒฐํ์๊น์?
+
+โ [๐ ์ค์๊ฐ ํธ์ง์ ๋น๋ฐ, ์ง๊ธ ๋ฐ๋ก ํ์ธํ๊ธฐ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EC%8B%A4%EC%8B%9C%EA%B0%84-%ED%8E%B8%EC%A7%91-%EA%B5%AC%ED%98%84-%EA%B3%BC%EC%A0%95)
+
-![image (14)](https://github.com/user-attachments/assets/ea6853d8-398e-4448-ae0a-07bffc653722)
+### ๐ ๋ฐ์ดํฐ ํ๋ฆ ๋ณ๊ฒฝ
-
+Octodocs ํ์ ๊ธฐ์กด RESTful API ๊ธฐ๋ฐ ์ํ ๊ด๋ฆฌ๋ฅผ ๋ฒ๋ฆฌ๊ณ **YDoc ์ค์ฌ์ ๋จ์ผ Truth Source**์ **์์ผ ๊ธฐ๋ฐ ๋จ๋ฐฉํฅ ํ๋ฆ**์ผ๋ก ์ ํํ์ต๋๋ค. ์ด๋ก ์ธํด ๋ชจ๋ ์ํ๊ฐ YDoc์ ํตํด ์ผ๊ด๋๊ฒ ๊ด๋ฆฌ๋๊ณ , ๋ฐ์ดํฐ ํ๋ฆ๋ ๊ฐ์ํ๋์์ต๋๋ค. ๊ธฐ์กด ๋ฐฉ์์ ๋ฒ๋ฆฌ๊ณ ์ด ๋ณํ๋ฅผ ์ ํํ ์ด์ ๋ ๋ฌด์์ผ๊น์? ๋ํ, ์ค๋ณต ๊ด๋ฆฌ์ ๋ฐ์ดํฐ ์ถฉ๋์ ์ค์ด๊ธฐ ์ํ **data flow ๋ณํ**์ ํต์ฌ์ ๋ฌด์์ด์์๊น์?
-# ๐บ๏ธ ํ๋ก์ ํธ ํ์๋ผ์ธ
+โ [๐ ๋ฐ์ดํฐ ํ๋ฆ์ ๋ชธ์ ๋งก๊ฒจ๋ณด๊ธฐ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EC%86%8C%EC%BC%93%EC%9C%BC%EB%A1%9C-%EC%9D%B8%ED%95%9C-%EC%83%81%ED%83%9C%EA%B4%80%EB%A6%AC%EC%9D%98-%EB%B3%B5%EC%9E%A1%EC%84%B1%EA%B3%BC-%EB%8D%B0%EC%9D%B4%ED%84%B0-%ED%9D%90%EB%A6%84-%EB%B3%80%EA%B2%BD)
-![Overview-variant (18)](https://github.com/user-attachments/assets/a503f8fe-bab9-4cf3-8d9d-98ff43ab0c3e)
+
+### ๐ธ๏ธ FE ํ๋ก์ ํธ ๊ตฌ์กฐ ๊ฐ์ ๊ณผ์
-# ๐ง ๋ฌธ์ ์ ํด๊ฒฐ๊ณผ์
+์งง์ ๊ธฐ๊ฐ์ ์คํ๋ฆฐํธ๋ฅผ ๋น ๋ฅด๊ฒ ๋ฐ๋ณตํ์ฌ ๊ฐ๋ฐํ๋ Octodocs ํ์ ์ด๋ ์๊ฐ๋ถํฐ ๊ธฐ๋ฅ์ ์ถ๊ฐํ๊ณ ์ ์ง๋ณด์ํ๊ธฐ ์ด๋ ต๋ค๋ ๋ฌธ์ ์ ์ ๋ง์ฃผํ์์ต๋๋ค. ๊ธฐ์กด **ํ๋ก์ ํธ ๊ตฌ์กฐ**์ ๋ฌธ์ ์ ์ ์ด๋ป๊ฒ ํ์
ํ๊ณ , ์ด๋ค ๋ฐฉ๋ฒ์ผ๋ก ๊ฐ์ ํ์๊น์?
-### ์ค์๊ฐ ํธ์ง ๊ตฌํ ๊ณผ์
+โ [๐ FSD, ํํ์ง๋ง ๋ง ๊ฐ๋ค ์ฐ์ง ์์์ต๋๋ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/FE-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EA%B5%AC%EC%A1%B0-%EA%B0%9C%EC%84%A0-%EA%B3%BC%EC%A0%95)
-Octodocs ํ์ ํต์ฌ ๊ธฐ๋ฅ์ธ ์๋ํฐ์ ๋
ธ๋ ์บ๋ฒ์ค์ **์ค์๊ฐ ํธ์ง**์ ์ํด **CRDT** ๋ผ์ด๋ธ๋ฌ๋ฆฌ์ธ **YJS**์ **SocketIO**๋ฅผ ์ด๋ป๊ฒ ํ์ฉ ํ์๊น์? [๐ ๋งํฌ ์ค๋น ์ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+
-### ๋ฐ์ดํฐ ํ๋ฆ ๋ณ๊ฒฝ
+### โจ ๋๋๊ทธ ์ด๋ฒคํธ ๋ฐ์ ์ ์๊ธฐ๋ ์ฟผ๋ฆฌ ์ต์ ํ
-YDoc๊ณผ ์์ผ์ ์ฌ์ฉํ๋ฉด์๋ RESTful ๋ฐฉ์์ผ๋ก ์ผ๋ถ ์ํ๋ฅผ ๊ด๋ฆฌํ๋ ๊ตฌ์กฐ๋ฅผ, YDoc ์ค์ฌ์ **๋จ์ผ truth source**์ ์์ผ ๊ธฐ๋ฐ **๋จ๋ฐฉํฅ ํ๋ฆ**์ผ๋ก ๋จ์ํํ์ต๋๋ค. ๊ทธ ๊ฒฐ๊ณผ ๋ชจ๋ ์ํ๊ฐ YDoc์ ํตํด ์ผ๊ด์ฑ ์๊ฒ ๊ด๋ฆฌ๋๋ฉฐ, ํด๋ผ์ด์ธํธ์ ์๋ฒ ๊ฐ ๋ฐ์ดํฐ ํ๋ฆ๋ ๊ฐ์ํ๋์์ต๋๋ค. ์ค๋ณต ๊ด๋ฆฌ์ ๋ฐ์ดํฐ ์ถฉ๋์ ์ค์ด๊ธฐ ์ํ ์ด๋ฐ **data flow ๋ณํ**์ ํต์ฌ์ ๋ฌด์์ด์์๊น์? [๐ ๋งํฌ ์ค๋น ์ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+๋
ธํธ ์นด๋๋ฅผ **๋๋๊ทธํ ๋ ๋๋ฌด ๋ง์ ์ฟผ๋ฆฌ๊ฐ ๋ฐ์**ํด ์๋ฒ๊ฐ ๋ฉ์ถ๋ ์น๋ช
์ ์ธ ๋ฌธ์ ๊ฐ ์์์ต๋๋ค. ํต์ฌ ๊ธฐ๋ฅ์ธ ์บ๋ฒ์ค๋ฅผ ์์ ์ด์ฉํ ์ ์์๊ธฐ์, ๋ฐ๋์ ํด๊ฒฐํด์ผ ํ๋ ๊ณผ์ ์์ต๋๋ค. Octodocs ํ์ ์์์ ๋จ์๋ก ๋ณํ๋ ์ขํ๋ฅผ DB์ ์ ์ฅํ๊ธฐ ์ํด ์ด๋ค ์ต์ ํ๋ฅผ ๋์
ํ์๊น์?
-### FE ํ๋ก์ ํธ ๊ตฌ์กฐ ๊ฐ์ ๊ณผ์
+โ [๐ ์ฐ์ธก์ผ๋ก 1mm๋ง ์ฎ๊ฒจ์ฃผ์ธ์](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EB%8D%B0%EC%9D%B4%ED%84%B0-%EA%B4%80%EC%B0%B0%2C-%EC%BF%BC%EB%A6%AC-%EB%B0%9C%EC%83%9D-%EC%B5%9C%EC%A0%81%ED%99%94-%EA%B3%BC%EC%A0%95)
-Octodocs ํ์ ๊ธฐ์กด **ํ๋ก์ ํธ ๊ตฌ์กฐ**์ ๋ฌธ์ ์ ์ ์ด๋ป๊ฒ ํ์
ํ๊ณ , ์ด๋ค ๋ฐฉ๋ฒ์ผ๋ก ๊ฐ์ ์ ํ์๊น์? [๐ ๋งํฌ ์ค๋น ์ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+
-### ๋๋๊ทธ ์ด๋ฒคํธ ๋ฐ์ ์ ์๊ธฐ๋ ์ฟผ๋ฆฌ ์ต์ ํ
+### ๐งจ Redis๋ฅผ ํ์ฉํ ๋ฐ์ดํฐ๋ฒ ์ด์ค ๋ถํ ์ค์ด๊ธฐ
+
+์ค์๊ฐ์ผ๋ก ๋ฌธ์๋ฅผ ๋์์ ํธ์งํ๋ฉด ๊ต์ฅํ ๋ง์ ๋ณ๊ฒฝ ์ฌํญ์ด ๋ฐ์ํฉ๋๋ค. ๋๊ตฐ๊ฐ ํ์ดํ์ ํ ๋๋ง๋ค ๋ณ๊ฒฝ ์ฌํญ๋ค์ ๋ชจ๋ ๋ฐ์ดํฐ๋ฒ ์ด์ค์ ๋ฐ์ํ๊ธฐ์๋ ๋ถํ๊ฐ ๋๋ฌด ๋ฐ์ํ๊ธฐ์, Octodocs ํ์ redis๋ฅผ ๋์
ํ๊ธฐ๋ก ๊ฒฐ์ ํ์ต๋๋ค. ์ด๋ค ์ง์ ์์ redis ๋์
์ ๊ฒฐ์ ํ๊ณ , ์ด๋ป๊ฒ redis๋ฅผ ํ์ฉํ๊ณ ์์๊น์?
+
+โ [๐ Redis ๊ฐ์ ๊ฑธ ๋ผ์น๋?](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
+
+
-**๋
ธํธ ์นด๋๋ฅผ ๋๋๊ทธ** ํ ๋, ๊ทธ ์์น๋ฅผ DB์ ์ ์ฅํ๊ธฐ ์ํด **๋๋ฌด ๋ง์ ์ฟผ๋ฆฌ๊ฐ ๋ฐ์**ํ๋ ๋ฌธ์ ๊ฐ ์์์ต๋๋ค. ์ด๋ฅผ ์ํด **์ฟผ๋ฆฌ๋ฅผ ์ต์ ํ**ํด์ผํ ํ์์ฑ์ด ์๊ฒผ๋๋ฐ ์ด๋ฅผ ์ด๋ป๊ฒ ํด๊ฒฐํ ์ ์์์๊น์? [๐ ๋งํฌ ์ค๋น ์ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+### ๐ณ ๊ฐ๋ฐ ํ๊ฒฝ, ๋ฐฐํฌ ํ๊ฒฝ ๋ฐ CI/CD์ ๋ํ ๊ฐ์ ๊ณผ์
-### redis ์บ์ฑ์ผ๋ก ๋ฐ์ดํฐ๋ฒ ์ด์ค ๋ถํ ๊ฐ์
+Octodocs ํ์ ์ฌ์ฉ์ ๊ฒฝํ ํฅ์์ ๋ฌผ๋ก , ์ผ๊ด๋ ์ฝ๋ ํ์ง ์ ์ง์ ๊ฐ๋ฐ์ ์นํ์ ์ธ ์พ์ ํ ๊ฐ๋ฐ ํ๊ฒฝ ์กฐ์ฑ์ ์ํด ๋ง์ ๋
ธ๋ ฅ์ ๊ธฐ์ธ์์ต๋๋ค. ๋ฉํฐ ๋ ํฌ์์ ๋ชจ๋
ธ๋ ํฌ๋ก์ ์ ํ, GitHub Actions๋ฅผ ํ์ฉํ CI/CD ๊ตฌ์ถ, Docker์ Docker Compose์ ๋์
๊น์งโ์ฐ๋ฆฌ๋ ์ด๋ค ๋ณํ๋ฅผ ๊ฑฐ์ณค์๊น์?
-์ค์๊ฐ ๋ฌธ์ ๋์ ํธ์ง์์ ๋ฐ์ํ๋ ๊ต์ฅํ ๋ง์ ๋ณ๊ฒฝ ์ฌํญ์ ๋ชจ๋ ๋ฐ์ดํฐ๋ฒ ์ด์ค์ ์ ์ฅํ๊ธฐ์๋ ๋ฐ์ดํฐ๋ฒ ์ด์ค ๋ถํ๊ฐ ๋๋ฌด ๋ง์ด ๋ฐ์ํ๊ณ , Octodocs ํ์ redis๋ฅผ ๋์
ํ๊ธฐ๋ก ๊ฒฐ์ ํ์ต๋๋ค. ์ ํฌ๋ ์ redis๋ฅผ ๋์
ํ๊ธฐ๋ก ๊ฒฐ์ ํ๊ณ ๋ redis๋ฅผ ์ด๋ป๊ฒ ํ์ฉํ์๊น์? [๐ ๋งํฌ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
+โ [๐ ํ๊ฒฝ ๊ฐ์ ์ ์ฌ์ ๋ฐ๋ผ๊ฐ๊ธฐ](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EA%B0%9C%EB%B0%9C-%ED%99%98%EA%B2%BD%2C-%EB%B0%B0%ED%8F%AC-%ED%99%98%EA%B2%BD-%EB%B0%8F-CI-CD%EC%97%90-%EB%8C%80%ED%95%9C-%EA%B0%9C%EC%84%A0-%EA%B3%BC%EC%A0%95)
-### ๊ฐ๋ฐ ํ๊ฒฝ, ๋ฐฐํฌ ํ๊ฒฝ ๋ฐ CI/CD์ ๋ํ ๊ฐ์ ๊ณผ์
+
-Octodocs ํ์ ์ฌ์ฉ์ ๊ฒฝํ ํฅ์์ ๋ฌผ๋ก , ์ผ๊ด๋ ์ฝ๋ ํ์ง ์ ์ง์ ๊ฐ๋ฐ์ ์นํ์ ์ธ ์พ์ ํ ๊ฐ๋ฐ ํ๊ฒฝ ์กฐ์ฑ์ ์ํด ๋ง์ ๋
ธ๋ ฅ์ ๊ธฐ์ธ์์ต๋๋ค. ๋ฉํฐ ๋ ํฌ์์ ๋ชจ๋
ธ๋ ํฌ๋ก์ ์ ํ, GitHub Actions๋ฅผ ํ์ฉํ CI/CD ๊ตฌ์ถ, Docker์ Docker Compose์ ๋์
๊น์งโ์ฐ๋ฆฌ๋ ์ด๋ค ๋ณํ๋ฅผ ๊ฑฐ์ณค์๊น์? [๐ ๋งํฌ ์ค๋น ์ค](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+๐งธ ํ์ ์๊ฐ
-# ๐งธ ํ์ ์๊ฐ
| [J032_๊น๋์ค](https://github.com/djk01281) | [J075_๊นํ์ค](https://github.com/Tolerblanc) | [J097_๋ฏผ์์ง](https://github.com/summersummerwhy) | [J162_์ ์ฑ๋ฏผ](https://github.com/ezcolin2) | [J248_์ง์์](https://github.com/yewonJin) |
|:----------------------------------------:|:------------------------------------------:|:------------------------------------------------:|:----------------------------------------:|:----------------------------------------:|
| | | | | |