vailabel/vailabel-studio

docs: Add a "Troubleshooting / Common Setup Issues" section to the README

Open

#240 aberto em 19 de jun. de 2026

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (22 forks)auto 404
documentationgood first issuehacktoberfest

Métricas do repositório

Stars
 (62 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Summary New contributors keep hitting the same setup snags. Collect them into one Troubleshooting section in the README so people can self-serve.

Where

  • README.md — add a ## 🩹 Troubleshooting section near the end of the Development section.

Steps

  1. Fork and branch: git checkout -b docs/readme-troubleshooting.
  2. Add a ## 🩹 Troubleshooting section covering:
    • Tauri prerequisites per OS — link https://tauri.app/start/prerequisites/ and list common Linux packages (webkit2gtk, librsvg).
    • Wrong Node/Yarn version — Node 20+ and Yarn Classic (v1); how to check (node -v, yarn -v).
    • macOS "app is damaged / unidentified developer" — the xattr -dr com.apple.quarantine workaround (cross-link the Download note).
    • Python runtime not found — short note + link to #238.
  3. Run yarn lint.
  4. Commit docs: add troubleshooting section to README and open a PR.

Acceptance criteria

  • README has a Troubleshooting section with at least the four items above.
  • yarn lint passes.

Good first issue — comment here if you'd like to take it.

Guia do colaborador

Direção de pesquisa
Abra o arquivo README.md, localize a seção Desenvolvimento e adicione uma nova subseção `## Solução de Problemas` com os quatro pontos listados no issue (pré requisitos do Tauri, versão do Node/Yarn, solução para quarentena no macOS, nota sobre o runtime Python). Faça referência cruzada com notas existentes quando mencionado. Execute `yarn lint` para verificar se a alteração está limpa.
Pilha de tecnologia
typescriptnodejs
Domain
documentationdeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90