Skip to content

docs: update logo to social-preview, normalize product name, add i18n aria-labels #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
singyichen merged 4 commits into from
Mar 26, 2026
Merged

docs: update logo to social-preview, normalize product name, add i18n aria-labels #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b37d260
docs: update logo to social-preview and normalize product name to Lab…
singyichen Mar 26, 2026
9a3cf57
docs: record second main branch violation incident in lessons-learned
singyichen Mar 26, 2026
2db1b3e
feat(assets): add banner.svg and update README to use banner logo
singyichen Mar 26, 2026
b42999f
fix: restore labelsuite-lang storage key and add aria-home i18n to da…
singyichen Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude/agents/nlp-research-advisor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You are an NLP research advisor with deep expertise in Chinese NLP, data annotat
## Project Context

Academic background for this project:
- **System Name**: LabelSuite
- **System Name**: Label Suite
- **Advisor**: Professor Lung-Hao Lee, Natural Language Processing Laboratory
- **Paper Type**: Demo Paper (system/tool paper)
- **Core Contribution**: Config-driven general-purpose NLP annotation platform with integrated annotator management
Expand Down
29 changes: 27 additions & 2 deletions .specify/memory/lessons-learned.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Claude Code directly committed and pushed logo assets to the `main` branch witho
**Incorrect workflow executed:**
```bash
git add assets/ .gitignore README.md README.zh-TW.md
git commit -m "feat: add LabelSuite logo and brand assets"
git commit -m "feat: add Label Suite logo and brand assets"
git push origin main # ❌ VIOLATION
```

Expand Down Expand Up @@ -51,7 +51,7 @@ git push origin main # ❌ VIOLATION
git checkout -b feat/logo-and-brand-assets
# Re-created all assets
git add assets/ .gitignore README.md README.zh-TW.md
git commit -m "feat: add LabelSuite logo and brand assets"
git commit -m "feat: add Label Suite logo and brand assets"
git push -u origin feat/logo-and-brand-assets
```

Expand Down Expand Up @@ -126,6 +126,31 @@ Before executing `git push`:

---

## 2026-03-26: Direct Commit to Main Branch — Second Violation

### Incident Summary
**Date:** 2026-03-26
**Severity:** High
**Type:** Git Workflow Violation (repeat offense)
**Reporter:** User (mandychen)
**Agent:** Claude Code (Sonnet 4.6)

### What Happened
Claude Code committed directly to `main` without creating a feature branch, despite the same violation being recorded on 2025-03-25.

### Root Cause Analysis
`lessons-learned.md` is stored in `.specify/memory/` which is NOT part of Claude's auto-memory system. The file is never automatically loaded into context, so the lesson had no effect on subsequent conversations.

### Remediation Steps Taken
1. Created branch `docs/logo-and-i18n-update` at current HEAD
2. Reset `main` to `origin/main` with `git reset --hard HEAD~1`
3. Added feedback memory to auto-memory system at `~/.claude/projects/.../memory/feedback_never_commit_to_main.md`

### Prevention
Lesson moved to auto-memory so it loads automatically in every future conversation.

---

## Template for Future Incidents

```markdown
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<p align="center">
<img src="assets/logo/icon-colored.svg" width="96" alt="LabelSuite Logo">
<img src="assets/logo/banner.svg" alt="Label Suite">
</p>

<h1 align="center">LabelSuite</h1>
<h1 align="center">Label Suite</h1>

<p align="center">
<a href="README.zh-TW.md">繁體中文</a> | <strong>English</strong>
Expand All @@ -23,7 +23,7 @@ Existing annotation platforms such as [Label Studio](https://labelstud.io/) are
- **Fragmented workflows:** Task configuration, labeling, and dataset analysis are often handled by separate tools or ad-hoc scripts, forcing researchers to repeatedly build one-off systems from scratch.
- **No dataset quality visibility:** Existing tools provide no built-in dataset statistics, forcing researchers to write analysis scripts after each labeling round.

**LabelSuite** aims to eliminate these pain points by providing a lightweight, config-driven annotation platform that any NLP research team can launch with minimal setup.
**Label Suite** aims to eliminate these pain points by providing a lightweight, config-driven annotation platform that any NLP research team can launch with minimal setup.

---

Expand Down Expand Up @@ -85,7 +85,7 @@ This project is positioned as a **Demo Paper**, with its core value in:

## Comparison with Label Studio

| Feature | Label Studio | **LabelSuite** |
| Feature | Label Studio | **Label Suite** |
|---|---|---|
| Easy setup (no server config) | ✗ | ✓ |
| Config-driven task definition | Partial | ✓ |
Expand Down Expand Up @@ -115,7 +115,7 @@ This project is positioned as a **Demo Paper**, with its core value in:
}
}}%%
gantt
title LabelSuite — Research Roadmap
title Label Suite — Research Roadmap
dateFormat YYYY-MM-DD
axisFormat %b %Y

Expand Down Expand Up @@ -152,7 +152,7 @@ gantt
- [ ] Survey Label Studio and identify pain points in setup, usability, and annotator management
- [ ] Conduct UX interviews and distribute a pain-point questionnaire to target users (researchers, annotators)
- [ ] Survey related academic papers on annotation platforms to establish positioning for the Related Work section
- [ ] Define the system's contribution: clarify how LabelSuite is simpler and more usable than Label Studio
- [ ] Define the system's contribution: clarify how Label Suite is simpler and more usable than Label Studio
- [ ] Study Demo Paper examples from target venue proceedings to understand structure, length, and demonstration requirements

### Phase 2 — System Design & General-Purpose Architecture (Month 5–8)
Expand Down
12 changes: 6 additions & 6 deletions README.zh-TW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<p align="center">
<img src="assets/logo/icon-colored.svg" width="96" alt="LabelSuite Logo">
<img src="assets/logo/banner.svg" alt="Label Suite">
</p>

<h1 align="center">LabelSuite</h1>
<h1 align="center">Label Suite</h1>

<p align="center">
<strong>繁體中文</strong> | <a href="README.md">English</a>
Expand All @@ -23,7 +23,7 @@
- **工作流程分散：** 任務配置、標記執行與資料集分析往往需要不同工具或自行撰寫腳本，導致研究團隊重複開發一次性系統。
- **缺乏資料集品質可視性：** 現有工具未提供內建的資料集統計功能，研究人員每次標記後都需撰寫分析腳本才能了解資料品質。

**LabelSuite** 旨在消除上述痛點，提供一個輕量、配置驅動的標記平台，讓任何 NLP 研究團隊都能以最少的設定快速啟動。
**Label Suite** 旨在消除上述痛點，提供一個輕量、配置驅動的標記平台，讓任何 NLP 研究團隊都能以最少的設定快速啟動。

---

Expand Down Expand Up @@ -85,7 +85,7 @@

## 與 Label Studio 比較

| 功能 | Label Studio | **LabelSuite** |
| 功能 | Label Studio | **Label Suite** |
|---|---|---|
| 簡易架設（免伺服器配置） | ✗ | ✓ |
| Config 驅動的任務定義 | 部分支援 | ✓ |
Expand Down Expand Up @@ -115,7 +115,7 @@
}
}}%%
gantt
title LabelSuite — 研究規劃
title Label Suite — 研究規劃
dateFormat YYYY-MM-DD
axisFormat %b %Y

Expand Down Expand Up @@ -152,7 +152,7 @@ gantt
- [ ] 調研 Label Studio，找出架設、易用性與標記員管理上的痛點
- [ ] 進行 UX 需求訪談，並發放使用者痛點問卷（目標對象：研究人員、標記人員）
- [ ] 調查標記平台的相關學術論文，為 Related Work 建立定位基礎
- [ ] 確立論文貢獻點：定義 LabelSuite 如何比 Label Studio 更好用、更簡便
- [ ] 確立論文貢獻點：定義 Label Suite 如何比 Label Studio 更好用、更簡便
- [ ] 研讀目標投稿場合的 Demo Paper 範例，了解結構、篇幅與展示需求

### 第二階段 — 系統設計與一般化架構（第 5–8 個月）
Expand Down
12 changes: 6 additions & 6 deletions assets/logo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# LabelSuite Logo & Brand Assets
# Label Suite Logo & Brand Assets

This directory contains the official LabelSuite logo and brand assets.
This directory contains the official Label Suite logo and brand assets.

## Files

Expand All @@ -10,7 +10,7 @@ This directory contains the official LabelSuite logo and brand assets.
|------|-------------|-------|
| `icon.svg` | Tag icon only (monochrome) | Favicon, small icons |
| `icon-colored.svg` | Icon with primary color background (48×48) | App icon, profile picture |
| `logo-horizontal.svg` | Icon + "LabelSuite" text | Header, documentation |
| `logo-horizontal.svg` | Icon + "Label Suite" text | Header, documentation |
| `social-preview.svg` | GitHub social preview (1280×640) | GitHub repository preview |

### PNG (Raster)
Expand Down Expand Up @@ -101,10 +101,10 @@ GitHub repositories don't have custom icons by default, but you can:

```markdown
<p align="center">
<img src="assets/logo/icon-colored.svg" width="96" alt="LabelSuite Logo">
<img src="assets/logo/icon-colored.svg" width="96" alt="Label Suite Logo">
</p>

<h1 align="center">LabelSuite</h1>
<h1 align="center">Label Suite</h1>
<p align="center">NLP Annotation Portal</p>
```

Expand Down Expand Up @@ -132,4 +132,4 @@ Then add to your HTML:

## License

These assets are part of the LabelSuite project. See the project's main LICENSE file for details.
These assets are part of the Label Suite project. See the project's main LICENSE file for details.
30 changes: 30 additions & 0 deletions assets/logo/banner.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/logo/icon-colored.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/logo/icon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/logo/logo-horizontal.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion design-system/labelsuite/MASTER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

---

**Project:** LabelSuite
**Project:** Label Suite
**Generated:** 2026-03-25 11:49:50
**Category:** Micro SaaS

Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/thesis/thesis-ch1-introduction.d2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pain_points: Pain Points {
p5: No Dataset Quality Visibility {class: base}
}

portal: LabelSuite {
portal: Label Suite {
class: module

o1: Config-driven Launch {class: base}
Expand Down
2 changes: 1 addition & 1 deletion docs/research/interviews/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# LabelSuite 使用者需求訪談
# Label Suite 使用者需求訪談

## 訪談目的

Expand Down
24 changes: 12 additions & 12 deletions docs/research/tool-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 標記工具分析

> 針對 Label Studio（參考基準）與 LabelSuite 進行多維度比較，涵蓋部署方式、任務支援、標記員管理、資料集統計、使用者體驗與技術架構，用於定義 LabelSuite 在 Demo Paper 中的貢獻與差異化定位。
> 針對 Label Studio（參考基準）與 Label Suite 進行多維度比較，涵蓋部署方式、任務支援、標記員管理、資料集統計、使用者體驗與技術架構，用於定義 Label Suite 在 Demo Paper 中的貢獻與差異化定位。

---

## 表一 — 系統概覽與定位

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **類型** | 通用型資料標記平台 | 具實驗室管理功能的 NLP 專用標記平台 |
| **目標使用者** | 企業、ML 工程師、資料團隊 | 超級管理員、實驗室研究生、兼職工讀生標記員 |
Expand All @@ -19,7 +19,7 @@

## 表二 — 部署與設定

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **設定方式** | 手動伺服器設定（Docker、環境變數、DB 遷移） | 單一設定檔（YAML/JSON）+ 一鍵啟動 |
| **工程背景需求** | 需要 DevOps / 工程背景 | 無需工程背景 |
Expand All @@ -32,7 +32,7 @@

## 表三 — NLP 任務類型支援

| 任務類型 | Label Studio | LabelSuite |
| 任務類型 | Label Studio | Label Suite |
|---|---|---|
| **單句任務**（分類 / 評分） | ✅（文字分類範本） | ✅（原生 NLP 範本） |
| **句對任務**（相似度 / 蘊含） | 🟡（需手動設定） | ✅（專用範本） |
Expand All @@ -45,7 +45,7 @@

## 表四 — 標記員管理

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **帳號管理** | 基本使用者帳號（無標記員角色區分） | 完整 CRUD，角色型存取控制（Admin / Researcher / Annotator） |
| **工讀生支援** | ❌ | ✅（專為實驗室工讀生工作流程設計） |
Expand All @@ -58,7 +58,7 @@

## 表五 — 資料集統計分析

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **內建統計功能** | ❌（無原生統計儀表板） | ✅（#Sentence、#Token、#Label） |
| **標籤分布視圖** | ❌ | ✅（即時類別不均衡偵測） |
Expand All @@ -71,7 +71,7 @@

## 表六 — 標記工作流程

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **試跑模式（Dry Run）** | ❌ | ✅（正式收集前驗證設定） |
| **正式模式（Official Run）** | ❌（單一模式） | ✅（資料與試跑模式嚴格隔離） |
Expand All @@ -84,7 +84,7 @@

## 表七 — 介面與使用者體驗

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **介面複雜度** | 高（功能豐富，學習曲線陡峭） | 低（精簡，聚焦任務） |
| **非工程師入門** | 困難（需閱讀文件） | 簡單（由設定檔結構引導） |
Expand All @@ -97,7 +97,7 @@

## 表八 — 技術架構

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **後端框架** | Django（Python）— 重量級，同步優先 | FastAPI（Python）— 輕量級，非同步原生 |
| **前端框架** | React 18 + TypeScript（Webpack 5、Nx monorepo） | React 18 + TypeScript + Vite |
Expand All @@ -113,7 +113,7 @@

## 表九 — 研究與學術適配性

| 比較維度 | Label Studio | LabelSuite |
| 比較維度 | Label Studio | Label Suite |
|---|---|---|
| **學術實驗室導向** | ❌（以企業 / ML 團隊為主） | ✅（專為 NLP 研究實驗室設計） |
| **中文 NLP 優化** | ❌ | ✅（醫療、情感、心理領域） |
Expand All @@ -124,9 +124,9 @@

---

## 總結 — LabelSuite 差異化定位
## 總結 — Label Suite 差異化定位

LabelSuite 鎖定 Label Studio 在**學術 NLP 實驗室**場景中的不足，提供：
Label Suite 鎖定 Label Studio 在**學術 NLP 實驗室**場景中的不足，提供：

1. **快速、零工程部署** — 設定檔取代繁瑣的伺服器設定流程
2. **標記員生命週期管理** — 所有現有工具均缺乏的內建人資功能
Expand Down
Loading
Loading