Primeiros Passos
KatanA Docs
Trabalhe com os documentos que você já tem.
Um guia objetivo da instalação ao primeiro documento.
Esta página guia você nos primeiros passos. Detalhes técnicos e de desenvolvimento estão disponíveis no repositório GitHub.
- 01
Guia rápido do site
- 02
Links para o repositório
- 03
Foco na experiência do leitor
Sessão Inicial
Abra uma pasta e leia como revisor
O KatanA brilha quando você já possui uma estrutura de documentação. Comece navegando sem alterar seus arquivos.
primeiros cinco minutos
Checklist dos primeiros 5 minutos
- Abra o README no workspace real.
- Abra um arquivo de especificacao de arquitetura.
- Abra um markdown com diagramas.
- Confirme TOC e split preview.
- Verifique configuracoes de update uma vez.
sdd e ai
Nota para fluxo SDD / AI
Use o KatanA para ler e validar specs antes de pedir mudancas a um agente.
Inicie em 3 Etapas
- Instale o KatanA via Homebrew ou download direto.
- Abra uma pasta (espaço de trabalho) que contenha arquivos Markdown.
- Use o KatanA para ler, revisar e comparar documentos antes de editar.
Abrindo seu Primeiro Espaço de Trabalho
O fluxo inicial do aplicativo antes de abrir seus primeiros arquivos.
Início
Estado Inicial Vazio
Ao abrir o app pela primeira vez, você verá uma tela limpa com opção direta de abrir uma pasta.
Menu
Acesso via Barra de Menu
Você também pode abrir novos espaço de trabalhos pelo menu Arquivo -> Abrir espaço de trabalho.
Configurações Recomendadas
Ajustes básicos que a maioria dos desenvolvedores prefere conferir primeiro.
Temas
Modo Escuro e Prévia ao Vivo
Ajuste a aparência do editor e da prévia usando predefinições integradas.
Layout da página
Sumário e Direção da Prévia
Configure a visibilidade do índice e a orientação da visão dividida (vertical ou horizontal).
Update
Preferências de Atualização
Gerencie a frequência de checagem automática de novas versões.
Atalhos
Configurações de Atalhos de Teclado
Personalize os atalhos de teclado para combinar perfeitamente com seu fluxo de trabalho.
O que priorizar na leitura
- Arquivos README para contexto geral do projeto.
- ADRs para entender decisões de design antes do código.
- Release Notes para acompanhar mudanças recentes de comportamento.