Referência
Visão geral
Seção intitulada “Visão geral”Use esta seção como ponto de entrada para o material de referência: inventários de APIs, chaves de configuração, tabelas de compatibilidade, comportamento de CSS com suporte e registros de cobertura entre pacotes.
Mapa de referência
Seção intitulada “Mapa de referência”| Referência | O que ela responde |
|---|---|
| Matriz de suporte a CSS | Quais recursos de CSS o pipeline de HTML verifica, declara, oferece suporte parcial ou não oferece suporte. |
| Índice da API de integrações | Qual página de API de extensão cobre cada framework, renderizador, transporte e superfície de ferramenta de build. |
| Seções de integração | Onde encontrar a referência de API e de configuração específica de cada pacote. |
| Referência do módulo core | Páginas de API e arquitetura em nível de módulo geradas a partir do repositório core. |
Contrato de entrada de referência
Seção intitulada “Contrato de entrada de referência”Toda entrada de API deve responder às mesmas perguntas:
| Pergunta | Resposta obrigatória |
|---|---|
| O que eu chamo? | Símbolo totalmente qualificado, endpoint, comando de interface de linha de comando (CLI) ou chave de configuração. |
| Qual entrada é aceita? | Tabela de parâmetros com tipo, status de obrigatoriedade, valor padrão e valores aceitos. |
| O que acontece por padrão? | O comportamento quando uma entrada opcional é omitida. |
| O que é retornado? | Tipo de retorno, corpo da resposta, saída de arquivo, stream (fluxo) ou efeito colateral. |
| O que pode falhar? | Exceção, erro de validação, status HTTP ou modo de falha operacional. |
| Como eu uso isso com segurança? | Notas sobre segurança, segurança em workers, limite de tamanho, caminho, timeout e tratamento de segredos. |
Política de cobertura
Seção intitulada “Política de cobertura”As páginas de referência se baseiam no código-fonte. As APIs públicas são documentadas a partir do código-fonte do pacote, dos arquivos de configuração, dos testes e dos exemplos. As classes auxiliares internas são documentadas apenas quando os desenvolvedores da aplicação precisam entender o comportamento delas para configurar ou operar o pacote.
Prontidão para tradução
Seção intitulada “Prontidão para tradução”As páginas de referência priorizam tabelas em vez de parágrafos densos. Cada linha deve ser autossuficiente, porque a segmentação posterior do Extensible Localization Interchange File Format (XLIFF) dividirá o conteúdo por bloco.