Estrutura do Projeto

Este repositório utiliza uma estrutura baseada em Docus para organização de documentação em Markdown.

Esta é a estrutura completa de diretórios e arquivos do projeto:

context-directory/
├── content/                        # Conteúdo em Markdown
│   ├── index.md                    # Página inicial
│   ├── 1.primeiros-passos/          # Seção introdutória
│   │   ├── .navigation.yml         # Configuração de navegação
│   │   ├── 1.para-agentes-ia.md    # Guia para agentes de IA
│   │   ├── 2.introducao.md         # Introdução geral
│   │   ├── 3.instalacao.md         # Guia de instalação
│   │   ├── 4.estrutura-projeto.md  # Este arquivo
│   │   └── 7.manutencao-conteudo.md # Guia de manutenção
│   └── 2.essentials/               # Conteúdo essencial
│       ├── .navigation.yml         # Configuração de navegação
│       ├── 1.sintaxe-markdown.md   # Sintaxe Markdown
│       ├── 2.blocos-codigo.md      # Blocos de código
│       ├── 3.componentes.md        # Componentes Markdown
│       └── 4.imagens-e-incorporacoes.md # Imagens e embeds
├── public/                          # Recursos estáticos
│   ├── favicon.ico                 # Ícone do site
│   └── mountains.webp              # Imagem de exemplo
├── package.json                    # Dependências e scripts
├── bun.lock                        # Lock file do Bun
├── README.md                       # Documentação principal
└── .gitignore                      # Arquivos ignorados pelo Git

Diretório content/

Este é onde você escreve as páginas em Markdown. Todos os arquivos .md neste diretório são processados e disponibilizados como documentação.

A estrutura hierárquica é mantida através de subdiretórios numerados:

• 1.primeiros-passos/: Documentação introdutória e guias essenciais
  • 1.para-agentes-ia.md: Instruções específicas para agentes de IA
  • 2.introducao.md: Introdução geral ao repositório
  • 3.instalacao.md: Guia de instalação via GitHub e npm
  • 4.estrutura-projeto.md: Este documento sobre estrutura
  • 7.manutencao-conteudo.md: Guia de manutenção de conteúdo
  • .navigation.yml: Configuração de navegação da seção
• 2.essentials/: Conteúdo essencial sobre Markdown e formatação
  • 1.sintaxe-markdown.md: Sintaxe básica do Markdown
  • 2.blocos-codigo.md: Como usar blocos de código
  • 3.componentes.md: Componentes Markdown disponíveis
  • 4.imagens-e-incorporacoes.md: Imagens e conteúdo incorporado
  • .navigation.yml: Configuração de navegação da seção

Cada diretório pode conter um arquivo .navigation.yml para configurar o título e ícone da seção na navegação.

Diretório public/

Arquivos contidos no diretório public/ são servidos na raiz e não são modificados pelo processo de build. Este é o local para colocar mídias, imagens e outros recursos estáticos.

Arquivos neste diretório podem ser referenciados diretamente nas páginas Markdown usando caminhos relativos à raiz (ex: /favicon.ico, /mountains.webp).

Arquivos de Configuração

.navigation.yml

Arquivos de navegação localizados em cada diretório de conteúdo (1.primeiros-passos/, 2.essentials/) configuram o título e comportamento da seção na navegação:

title: Primeiros Passos
icon: false

README.md

Documentação principal do repositório, contendo visão geral, características, instruções de instalação e links para documentação adicional.

app.config.ts

Aqui você pode configurar o Docus para ajustar branding, lidar com SEO e adaptar links e redes sociais. Para este repositório de conhecimento, as configurações podem ser mantidas em padrão ou ajustadas conforme necessário.