[[Guia do Colaborador]]

• Boas vindas ao repositório da documentação do projeto Querido Diário.
• Contribuindo para a Documentação do Querido Diário
  • Instalação e Configuração do Obsidian
  • Como criar, editar e vincular documentos - Estrutura de diretórios - Criando um novo documento - Pesquisando por arquivos específicos - Vinculando informações - Submetendo suas contribuições

Boas vindas ao repositório da documentação do projeto Querido Diário.

Acreditamos que a documentação vai além das descrições técnicas; ela é uma peça fundamental no processo de aprendizagem. Com essa perspectiva em mente, nossa missão é tornar a documentação do projeto Querido Diário o mais acessível e fluida possível, beneficiando tanto os colaboradores experientes quanto os recém-chegados.

Para atingir essa meta, adotamos uma abordagem fortemente baseada em links hipertextuais. Cada fragmento de informação é habilmente interligado a outros, de maneira intuitiva e natural, enriquecendo o contexto e facilitando uma compreensão profunda e abrangente do projeto.

Para possibilitar essa experiência, optamos pela utilização do software Obsidian como ferramenta de edição da documentação. O Obsidian é um editor de texto markdown gratuito e multiplataforma que se destaca pela simplicidade e por sua capacidade de criar conexões entre documentos, mantendo sua integridade referencial, além de oferecer funcionalidades avançadas de pesquisa. Esses recursos tornam a edição, exploração e a navegação através das informações uma experiência simplificada e altamente enriquecedora.

Estamos comprometidos em fornecer um ambiente onde a aprendizagem e a colaboração florescem, impulsionadas por uma documentação coesa e bem organizada.

Contribuindo para a Documentação do Querido Diário

Instalação e Configuração do Obsidian

Se você deseja contribuir para a documentação do Querido Diário, siga os passos abaixo para instalar e configurar o Obsidian:

1. Instalação do Obsidian: Antes de começar, é necessário instalar o Obsidian em seu computador. Você pode encontrar instruções detalhadas sobre como fazer isso aqui.

2. Clonar ou Baixar o Repositório: Clone este repositório para o seu computador ou faça o download do arquivo .zip contendo os arquivos. Se estiver usando o Git, você pode clonar o repositório com o comando git clone [URL do repositório].

   Se você optar por baixar o arquivo .zip, não se esqueça de descompactá-lo.

3. Abrir o Vault no Obsidian: Abra o software Obsidian e, na opção "Open folder as vault" (vault, ou cofre, é o termo usado pelo Obsidian para se referir à pasta de trabalho), selecione a pasta obtida do GitHub, denominada qd-doc.

4. Ativar Plugins: Para algumas funcionalidades importantes do aproveitar ao máximo a experiência do Obsidian, recomendamos ativar todos os plugins. Isso pode ser feito em "Settings" -> "Community Plugins". Atualmente, os plugins instalados incluem "Dataview" e "Templater".

Seguindo essas etapas, você estará pronto para contribuir para a documentação do Querido Diário. O próximo passo é entender a criação ou edição de documentos e como criar links entre as informações.