From 647a73432fe9c3882ce21ca508a729a580f6bdf3 Mon Sep 17 00:00:00 2001 From: Yu-Tsen Wei <59054102+frobel0520@users.noreply.github.com> Date: Tue, 29 Sep 2026 23:25:34 +0800 Subject: [PATCH 1/2] docs: standardize README overview --- README.md | 44 ++++++++++++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 43ad036..aefd72c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Software Engineering Workshop -一個可以動手操作、也可以逐章擴充的軟體工程教材站。 +> 一個可以動手操作、也可以逐章擴充的軟體工程教材站。 + +## 概覽 網站:https://frobel0520.github.io/software-engineering-workshop/ (部署來源:`frobel0520/software-engineering-workshop`) @@ -12,21 +14,7 @@ 目前可操作的 Core 主題有 19 / 19 個:**Git**、**GitHub/GitLab 遠端協作**、**命令列**、**IDE/除錯器**、**套件管理**、**環境變數**、**建置工具**、**REST API/FastAPI**、**身分驗證/授權**、**SQL**、**資料庫設計**、**索引與交易**、**PostgreSQL**、**單元測試**、**整合測試**、**日誌**、**Docker 基礎**、**CI/CD**、**部署**;另有 2 個不計入 Core 進度的 Extension:**Guardrails**、**問題處理方法**。Core 19 個主題全部開放。 -## Git 單元 - -- Git Lesson:涵蓋 `clone`、`add`、`commit`、`push`、`pull`、`fetch`、`checkout`、`rebase`、`stash`、`cherry-pick`、`merge` 與 GitHub/GitLab `fork`。 -- 指令式 cowork Lab:親自走過 local history → remote branch → PR/MR → pipeline → merge。 -- Pipeline fixture:顯示 `checkout`、`npm ci`、`test`、`lint`、`build` jobs 與 conflict/retry 情境。 -- 確定性的瀏覽器模擬引擎,不會動到使用者電腦上的真實 repository。 -- 進度保存在瀏覽器;每個已開放主題完成 Lab 後,才會標記該主題完成。 - -## Auth 單元 - -- Entra ID、OIDC、SSO 與七個 App Registration 設定值。 -- 假資料驅動的設定判斷與 Authorization Code + PKCE 流程 Demo。 -- 不連線 Microsoft、不處理真實帳號或 Secret。 - -## 其他已開放主題 +## 主要功能/內容 - 遠端協作:模擬 `branch → commit → fetch → rebase → push → PR → CI → merge` 閉環。 - 命令列:在固定 fixture 中練習工作目錄、檔案讀取、搜尋與檢查流程。 @@ -43,6 +31,30 @@ - Guardrails Extension:模擬輸入、輸出與工具呼叫的安全防線,不連線真實模型。 - 問題處理 Extension:從問題定義、重現、蒐證、假設、錯誤邊界到驗證與預防復發。 +## 現況與已知限制 + +Core/Extension 功能開發已完成,現處測試與驗收階段。原 README 記錄 2026-08-23 的自動化基線;本次未重跑測試。 + +## 授權與來源 + +Repository 根目錄未見授權檔;此 README 不另行宣告使用或再散布權利。 + +--- + +## Git 單元 + +- Git Lesson:涵蓋 `clone`、`add`、`commit`、`push`、`pull`、`fetch`、`checkout`、`rebase`、`stash`、`cherry-pick`、`merge` 與 GitHub/GitLab `fork`。 +- 指令式 cowork Lab:親自走過 local history → remote branch → PR/MR → pipeline → merge。 +- Pipeline fixture:顯示 `checkout`、`npm ci`、`test`、`lint`、`build` jobs 與 conflict/retry 情境。 +- 確定性的瀏覽器模擬引擎,不會動到使用者電腦上的真實 repository。 +- 進度保存在瀏覽器;每個已開放主題完成 Lab 後,才會標記該主題完成。 + +## Auth 單元 + +- Entra ID、OIDC、SSO 與七個 App Registration 設定值。 +- 假資料驅動的設定判斷與 Authorization Code + PKCE 流程 Demo。 +- 不連線 Microsoft、不處理真實帳號或 Secret。 + ## 本機啟動 ```bash From 7b7d626828b21a52737414d352023b55a2bd5f96 Mon Sep 17 00:00:00 2001 From: Yu-Tsen Wei <59054102+frobel0520@users.noreply.github.com> Date: Wed, 7 Oct 2026 21:58:54 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs(guardrail-brief):=20=E7=A7=BB=E9=99=A4?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E4=B8=AD=E7=9A=84=E6=9C=AC=E6=A9=9F=E8=B7=AF?= =?UTF-8?q?=E5=BE=91=20(#120)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - docs/guardrail-rebuild-feature-brief.md:參考來源由個人電腦路徑改為 guardrail-workshop 的 GitHub 連結 驗證:repo 中已搜尋不到本機使用者路徑。 --- docs/guardrail-rebuild-feature-brief.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guardrail-rebuild-feature-brief.md b/docs/guardrail-rebuild-feature-brief.md index 71531ae..9652579 100644 --- a/docs/guardrail-rebuild-feature-brief.md +++ b/docs/guardrail-rebuild-feature-brief.md @@ -2,7 +2,7 @@ > 狀態:Implemented v1 > 日期:2026-08-16 -> 參考來源:`C:\Users\ytwei\Projects\Guardrail-Workshop` +> 參考來源:[guardrail-workshop](https://github.com/frobel0520/guardrail-workshop) > 依附架構:`docs/project-sa.md`、`docs/project-sd.md` ## 1. 定位