adhit-r / adhit-r/aran

Improve Developer Experience and Documentation

Aberta
#43 0 comentários 0 reações 1 responsável Reivindicada por @adhit-r Ver no GitHub
documentation enhancement
Linguagem predominante
TypeScript
Estrelas
4
Forks
0
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

**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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Start by reading QUICK_WINS.md, the existing README, and the repository's current documentation and editor configuration. Update or add DEVELOPMENT.md, .vscode/settings.json, .vscode/extensions.json, docs/SCHEMA.md, and docs/TROUBLESHOOTING.md, then verify the README and onboarding flow satisfy the listed acceptance criteria.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
typescript, vscode
Domínio
developer-experience, documentation, tooling
Tipo de issue
Documentação
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.