Wiki

Crie e gerencie a documentação do projeto diretamente no seu editor de código. Navegue por páginas hierárquicas, edite com Markdown, acompanhe revisões e pesquise em toda a sua base de conhecimento.

O Problema que Isso Resolve

A documentação do projeto fica em uma ferramenta, o código em outra. Quando você precisa consultar especificações de API, decisões de arquitetura ou guias de configuração, você troca para o navegador, encontra a página da wiki, lê e volta. Cada troca de contexto interrompe seu fluxo.

O GitScrum Studio coloca a wiki dentro de um painel do editor. Consulte a documentação enquanto programa, atualize-a conforme implementa e nunca saia do seu ambiente de desenvolvimento.

O que Você Está Vendo

Clique em Wiki na seção Knowledge na árvore lateral. O painel abre com uma navegação em árvore à esquerda e uma área de conteúdo à direita.

Árvore de Páginas

O lado esquerdo mostra todas as páginas da wiki organizadas em hierarquia. As páginas podem conter páginas filhas, criando estruturas aninhadas para documentação organizada:

Primeiros Passos
  ├─ Guia de Instalação
  ├─ Configuração
  └─ Deploy
Referência da API
  ├─ Autenticação
  ├─ Endpoints
  └─ Códigos de Erro
Arquitetura
  └─ Esquema do Banco de Dados

Expanda e recolha as páginas pai para navegar pela árvore. Clique em qualquer página para carregar seu conteúdo no painel direito.

Área de Conteúdo

O lado direito exibe o conteúdo da página selecionada. No topo, você vê o título da página e a navegação por breadcrumbs mostrando a posição da página na hierarquia.

Criando Páginas

Clique no botão de criação no cabeçalho do painel para abrir o formulário de nova página:

Deixe o campo pai vazio para criar uma página no nível raiz. Selecione uma página existente como pai para criar uma página filha aninhada.

Editando Páginas

Clique no botão de edição em qualquer página para alternar para o modo de edição. A área de conteúdo se transforma em um editor onde você pode modificar:

• Título — O cabeçalho da página
• Conteúdo — Edição completa em Markdown com formatação padrão

Salve suas alterações ou cancele para reverter. As edições são salvas no servidor imediatamente.

Histórico de Revisões

Cada edição cria uma revisão. Clique no botão de revisões para visualizar o histórico de alterações da página:

Restaurando Versões Anteriores

Você pode restaurar qualquer revisão anterior. Isso cria uma nova revisão que reverte o conteúdo para a versão selecionada. O conteúdo anterior é preservado no histórico — nada é perdido permanentemente.

Excluindo Páginas

Clique no botão de exclusão em uma página para removê-la. Um diálogo de confirmação aparece antes da exclusão. Excluir uma página pai pode afetar páginas filhas — revise a hierarquia cuidadosamente antes de confirmar.

Busca

Use o campo de busca no topo do painel da wiki para filtrar páginas. A busca é realizada nos títulos das páginas e exibe resultados em tempo real conforme você digita.

Dicas Avançadas (Quando Você Já Estiver Confortável)

• Visualização dividida com o código. Abra o painel da wiki ao lado dos seus arquivos de código. Consulte documentação de API ou guias de arquitetura enquanto implementa.

• Use aninhamento para estruturar. Organize as páginas por módulo, funcionalidade ou equipe. Hierarquias profundas são mais fáceis de navegar do que listas planas de páginas.

• Documente enquanto programa. Quando você implementar um algoritmo complexo ou configurar uma integração difícil, atualize a wiki imediatamente. Leva 30 segundos enquanto o contexto está fresco vs. 30 minutos depois quando você já esqueceu os detalhes.

• Verifique as revisões antes de editar. Se um colega atualizou uma página recentemente, revise as alterações dele para evitar sobrescrever o trabalho.

Permissões

A extensão respeita as permissões da sua conta GitScrum:

• Agency Owners e Managers: Acesso CRUD completo a todas as páginas da wiki
• Desenvolvedores: Podem criar, editar e visualizar páginas da wiki em projetos atribuídos
• Clientes: Acesso somente leitura às páginas da wiki (se tiverem acesso ao projeto)

Como Reportar um Problema ou Solicitar uma Funcionalidade

Se as páginas da wiki não carregarem, as alterações falharem ao salvar ou o histórico de revisões parecer incompleto, abra um ticket de suporte na aplicação web do GitScrum. Navegue até Support Tickets na barra lateral e descreva o problema. Inclua a versão da extensão e os detalhes do editor.