adhit-r / adhit-r/aran

Improve Developer Experience and Documentation

未關閉
#43 0 則留言 0 個 reaction 已指派 1 人 已被 @adhit-r 認領 在 GitHub 檢視
documentation enhancement
主要語言
TypeScript
星號
4
分支
0
PR 合併指標
30 天內沒有已合併 PR

描述

**Goal**: Enhance developer onboarding and daily workflow through improved docs and editor settings.

---

### Tasks
- Write a comprehensive DEVELOPMENT.md (setup, structure, troubleshooting)
- Add VSCode workspace settings (`.vscode/settings.json` and `.vscode/extensions.json`)
- Document PocketBase schema in `docs/SCHEMA.md`
- Add troubleshooting guide `docs/TROUBLESHOOTING.md`
- Upgrade main README with badges, quick start, diagram, guidelines, demo credentials

**References:** See [QUICK_WINS.md](https://github.com/adhit-r/aran/blob/main/QUICK_WINS.md)

**Acceptance Criteria**
- New contributors can onboard and run the project with docs alone
- Recommended extensions/settings enforced for VSCode
- Schema and troubleshooting docs committed
- README clearly covers setup, usage, contribution, and project highlights

貢獻指南

開啟貢獻指南

研究方向

先閱讀 QUICK_WINS.md、現有的 README,以及儲存庫目前的文件和編輯器設定。更新或新增 DEVELOPMENT.md、.vscode/settings.json、.vscode/extensions.json、docs/SCHEMA.md 和 docs/TROUBLESHOOTING.md,然後確認 README 和新手導覽流程符合列出的驗收標準。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
typescript, vscode
領域
developer-experience, documentation, tooling
Issue 類型
文件
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。