Squad Front

Appearance

Portal de Onboarding - Squad Web, Design & QA ​

Este projeto contém a documentação centralizada de onboarding para novos colaboradores da equipe de Front-End, Design e QA. O portal foi construído utilizando Vitepress para proporcionar uma experiência de navegação rápida, organizada e profissional.

Objetivo ​

Facilitar a rampa de aprendizado de novos membros, garantindo que todos tenham acesso aos padrões técnicos, arquitetura do sistema, diretrizes de design e processos de qualidade desde o primeiro dia.

Tecnologias Utilizadas ​

  • Vitepress - Gerador de sites estáticos focado em documentação.
  • Node.js (v20+)
  • WebStorm - IDE padrão obrigatória para a equipe Web.

Estrutura do Projeto ​

  • docs/: Contém todos os arquivos markdown da documentação.
    • architecture/: Detalhes da arquitetura por camadas (Application, Feature, Screen).
    • codestyle/: Guias de estilo de código e padrões de desenvolvimento.
    • company/: Contexto institucional e projetos (Teleconsulta, Telediagnóstico).
    • design/: Fundamentos de UX, Design Tokens, Variants e Handoff.
    • onboarding/: Trilhas específicas por cargo (Front-End, Design, QA).
    • technical-guides/: Explicações detalhadas sobre hooks, Redux, TanStack Query, etc.
  • .vitepress/: Configurações do portal (sidebar, navbar, tema).
  • .ai/: Contexto e diretrizes para o Agente de IA de onboarding.

Como Rodar Localmente ​

Certifique-se de ter o Node.js instalado em sua máquina.

  1. Instale as dependências:

    bash
    npm install

  2. Inicie o servidor de desenvolvimento:

    bash
    npm run docs:dev

    O portal estará disponível em http://localhost:5173.

  3. Gerar build de produção:

    bash
    npm run docs:build

Como Contribuir ​

A documentação é um organismo vivo. Se você encontrar algo desatualizado ou sentir falta de algum conteúdo:

  1. Crie uma nova branch seguindo o padrão docs/seu-tema.
  2. Adicione ou edite os arquivos .md na pasta docs/.
  3. Se criar um novo arquivo, lembre-se de registrá-lo no menu lateral em .vitepress/config.mts.
  4. Abra um Pull Request para revisão.

Squad Front-End & Design