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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。