Comece Aqui
Nesta documentação você vai encontrar o passo a passo para executar os nossos principais projetos da Beep. Além disso, vai conter alguns scripts para o time de suporte, facilitando também essa interação.
Criando uma documentação
Para criar uma nova documentação você pode ter como exemplo as que já existem no projeto, ou então acessar a documentaçã da Docussaurs. Nela você encontra todos os componentes para adicionar a sua documentação.
A documentação pode ser escrita em Markdown (.md) ou uma variação usando o React (.mdx). Neste segundo formato, ganhamos a possibilidade de adicionar componentes Reacts dentro da nossa documentação em markdown.
Fique a vontade para fazer sugestões, correções ou adicionar uma nova documentação do projeto em que você está trabalhando. O ideal é mantermos um padrão de pastas ou arquivos para que fique fácil de editar/adicionar a documentação. 😄
Próximas features
⏳ Adição de campo de busca
Adicionaremos um campo de busca para facilitar a busca por termos dentro da documentação.
⏳ Adicionar as Releases dos projetos
Adicionaremos as nossas Releases, para acompanharmos os novos lançamentos e as mudanças realizadas e assim homogenizar o time como um todo.