---
sidebar_position: 2
title: "Trabalhando com Docusaurus"
---

Esta seção cobre apenas o necessário para manter a documentação técnica do projeto.

## Estrutura relevante

```mermaid
graph TD
    A[docs/] --> B[**docusaurus.config.js**
configuração geral]
    A --> C[**sidebars.js**
navegação]
    A --> D[**docs/**
doc técnica]
    A --> E[**edu/**
doc pedagógica]
```

- `docs/docusaurus.config.js`: configuração geral.
- `docs/sidebars.js`: navegação.
- `docs/docs/`: documentação técnica.
- `docs/edu/`: documentação pedagógica.

Referência externa:

- Docusaurus docs: https://docusaurus.io/docs

## Fluxo de edição

```mermaid
flowchart LR
    A[Editar .md em docs/docs] --> B[Rodar servidor local]
    B --> C[Revisar navegação e links]
    C --> D[Rodar build]
    D --> E[Concluir alteração]
```

## Comandos

```bash
cd docs
pnpm install
pnpm run start
```

Build local:

```bash
cd docs
pnpm run build
pnpm run serve
```

## Boas práticas editoriais

- Prefira frases curtas e diretas.
- Evite blocos de código longos quando uma explicação curta resolver.
- Use exemplos apenas quando ajudam a esclarecer uma decisão técnica.
- Mantenha consistência com a nomenclatura da plataforma: **atividade**.

## Checklist rápido antes de concluir

- O texto está coerente com o código atual?
- Os links externos apontam para fontes confiáveis?
- A página está com leitura natural e sem repetição?
- O build da doc passou sem erro?
