Documentação integrada
O Chinaski carrega sua documentação dentro da área admin: Docs lista artigos embutidos mais artigos que você mesmo escreve, todos apenas para admin. Esta página cobre ambos.
Os artigos embutidos
Dez artigos distribuídos vêm com a aplicação, cada um cobrindo um subsistema principal (o índice desta página vive em Admin → Docs):
- Blocks: criar e gerenciar blocos de conteúdo reutilizáveis; tipos, formato de template, embutimento.
- Theme Authoring: a referência completa de Template Toolkit para templates de site e bloco, com as regras de segurança e a referência completa de variáveis.
- LLM Theme Prompting: orientação para produzir temas ambiciosos e visualmente distintos com assistentes de IA: design briefs, especificações de tokens, laços de crítica e modelos de prompt de copiar e colar.
- Pages & Posts: criar, editar, publicar, agendar, categorias, revisões.
- Navigation: construir menus, ordenação, links externos, navegação por idioma.
- Backups: criar/restaurar backups, a agenda, o formato de arquivo.
- Settings: nome do site, idiomas, padrões de SEO, IDs de analytics, o aviso de cookies, configuração de URL.
- Media Library: fazer upload, organizar, referenciar URLs de mídia.
- MCP Server: o servidor Model Context Protocol para gestão por assistentes de IA.
- API Reference: a referência completa de
/api/*(autenticação, paginação, corpos de requisição, schemas de resposta).
A documentação vai mais a fundo do que o site público de documentação; por exemplo, o artigo Theme Authoring carrega a tabela completa de stash-variables por tipo de template.
Escrevendo seus próprios artigos
Junto aos embutidos, existe um conjunto editável para docs customizados (suas páginas de runbook para editores, guias de estilo da casa, notas de migração para um cliente), e são dados totalmente dentro do repositório:
- New article: um título é exigido; o slug vem da sua entrada ou é gerado automaticamente a partir do título (minúsculas, separado por hífens); caracteres de slug inválidos são removidos.
- Ordem de classificação: controla a posição de leitura no índice de docs (a ordenação desempata pela ordem de criação).
- Body: texto de corpo arbitrário, editável por artigo; salvo no banco de dados (com os backups da sua instância, como todo o resto).
O índice lista seus docs customizados abaixo dos embutidos, ordenados pelas suas ordens de classificação. Tudo o que você escreve permanece como dado local à instância: nada é sincronizado ou publicado publicamente; escreva runbooks como documentação interna para sua equipe.
Os docs são território de admin
Porque alguns artigos cobrem operações privilegiadas (internos de tema, chaves de API, layouts de backup), toda rota de doc, incluindo rascunhos, é bloqueada por admin: editores sem papel de admin nunca veem esta seção.