Documentação do Quoti

Bem-vindo ao repositório oficial da documentação do Quoti no GitHub. Este repositório contém toda a documentação necessária para o Quoti, a plataforma inovadora criada para otimizar a gestão empresarial e a comunicação.

Sobre o Quoti

O Quoti é uma plataforma abrangente que capacita empresas e organizações a gerir projetos de maneira mais eficaz, aprimorar a comunicação interna e externa e facilitar a tomada de decisões baseadas em dados. Construído para proporcionar uma experiência intuitiva e fluída aos seus usuários, o Quoti se destaca por suas bases de dados customizáveis, métodos de autenticação versáteis e amplas capacidades de integração.

Documentação Oficial

Para visualizar a documentação em seu estado atual, visite o site oficial: docs.quoti.cloud. Aqui você pode explorar todos os aspectos da plataforma Quoti, entender melhor suas funcionalidades e aprender como integrá-la ao seu negócio ou instituição educacional.

Obrigado por interessar-se em contribuir para a documentação do Quoti e ajudar a comunidade a crescer!

Como Contribuir

Acreditamos na colaboração e valorizamos as contribuições da comunidade para nossa documentação. Seja corrigindo um erro de digitação, adicionando mais detalhes ou aprimorando as informações existentes, suas iniciativas em melhorar a nossa documentação são muito bem-vindas.

A não ser que você seja desenvolvedor Quoti, para contribuir, siga os passos:

1. Faça um fork do repositório: Comece fazendo um fork do repositório quoti-docs para realizar suas contribuições.
2. Clone o fork para sua máquina local e faça as alterações: Use o git para clonar o repositório para seu ambiente local e depois faça as mudanças que considerar necessárias.
3. Commit e push das suas alterações: Após fazer as alterações, faça commit para o seu fork e então um push para enviar as alterações para o seu repositório no GitHub.
4. Crie um Pull Request: No GitHub, no repositório original do quoti-docs, crie um pull request para que sua contribuição seja revisada e, se tudo estiver de acordo, incorporada à documentação oficial.

Usando o MkDocs

A documentação é criada com o MkDocs, um gerador de sites estáticos rápido, simples e visualmente agradável, focado na construção de documentação de projetos. Os arquivos de origem da documentação são escritos em Markdown e configurados com um único arquivo de configuração YAML.

Como rodar o projeto localmente

Rode, na raiz:

1. pip install -r requirements.txt
2. mkdocs serve