Tiramos a documentação do modal

Você está escrevendo a página de onboarding de um serviço de pagamentos. Seis títulos, dois blocos de código, uma tabela das filas que ele consome e um parágrafo que você reescreve sem parar, porque é o parágrafo que o próximo engenheiro vai ler de verdade.

No Archyl, até esta semana, você escrevia tudo isso dentro de uma caixa de diálogo. A página atrás dela escurecia. A árvore de documentos, onde ficam as páginas irmãs e onde você iria conferir como chamou a última, escurecia junto. O editor preenchia a caixa de diálogo, a caixa de diálogo não era a tela, e ler uma página e escrever uma página aconteciam em dois lugares diferentes.

Funcionava. E também não parecia muito profissional, que é a frase à qual eu voltava sem parar até sentar e reconstruir tudo.

O workspace de documentação não tem mais nenhum modal dentro dele. Foi isto que entrou no lugar.

O editor abre onde o documento está

Clique em Editar numa página, ou pressione E enquanto a lê, e o editor assume a coluna de conteúdo ali mesmo. A árvore fica onde estava, com brilho total, ainda clicável. Nada se sobrepõe a nada.

O documento parece um documento enquanto você o escreve. O título é um campo simples no tamanho de um título, sem rótulo e sem caixa em volta. As tags ficam embaixo: digite e pressione Enter ou vírgula para adicionar uma, backspace num campo vazio para pegar a última de volta. O caminho da pasta corre pelo topo da barra de ações, então você sempre sabe onde a página que está escrevendo vai aterrissar.

A barra também carrega o estado. Um ponto âmbar e Alterações não salvas enquanto o rascunho difere do que está armazenado, depois Salvar com a sua dica ⌘↵. Esse atalho funciona de qualquer lugar do editor, inclusive de dentro do corpo Markdown, então você nunca precisa voltar até o botão. Há um alternador de tela cheia ao lado do seletor de modo para quando você quer o parágrafo e mais nada, e Escape traz você de volta. Na borda inferior, uma contagem de palavras e um tempo de leitura.

Escrever, Dividido, Pré-visualização

O editor tem três modos, e eles são a única decisão de barra de ferramentas que você precisa tomar:

  • Escrever é só Markdown, na largura inteira da coluna.
  • Dividido coloca o código-fonte e a página renderizada lado a lado.
  • Pré-visualização é a página renderizada sozinha.

Dividido é o padrão. Seja qual for o que você escolher, o Archyl guarda no seu navegador e reabre todos os documentos assim, de modo que quem escreve em Markdown puro e quem quer ver os títulos renderizados nunca precisam discutir sobre isso nem reajustar em cada página.

Pastas são uma linha na árvore

Criar uma pasta era, antes, uma caixa de diálogo própria: uma caixa, um campo de texto, um botão Criar e nenhuma pista de onde a pasta estava prestes a aparecer.

Agora, clicar no ícone de pasta no cabeçalho da árvore abre uma linha editável exatamente onde a pasta vai morar, no recuo certo, com o ícone de pasta já desenhado. Digite o nome, pressione Enter, e ela existe. Escape cancela. Peça uma subpasta pelo menu da própria pasta e a superior se expande e a linha aparece lá dentro.

Renomear funciona do mesmo jeito, na linha. Mover páginas e pastas continua sendo arrastar e soltar.

Você não consegue clicar para longe de trabalho não salvo

Todo movimento dentro do workspace de documentação passa por uma única guarda: selecionar outra página na árvore, começar uma página nova, abrir outra para edição, cancelar e sair do editor. Se o rascunho tem alterações não salvas, a ação fica retida e você recebe uma confirmação antes, com Continuar editando como saída e Descartar alterações como a opção deliberada. Assim que você confirma, a ação que pediu originalmente é executada.

O navegador também está coberto. Fechar a aba com um rascunho não salvo levanta o aviso do próprio navegador.

Essa é a mudança menos visível da release e a que eu defenderia com mais força. Uma árvore de páginas clicáveis ao lado de um editor só é um bom layout se clicar não puder custar um parágrafo a você.

O sumário segue o painel, não a janela

Quando a coluna é larga o bastante, os títulos da página ficam num trilho fixo à direita do texto, com a seção atual marcada conforme você rola. Quando ela é estreita demais para um trilho, eles se recolhem num popover Conteúdo na barra de ferramentas.

A troca entre esses dois é regida pela largura do painel, não pela largura da janela do navegador. Essa distinção é o ponto inteiro: a coluna de docs divide o espaço com a árvore, então um monitor de 27 polegadas com a árvore aberta é uma janela larga em volta de uma coluna de leitura estreita. Um breakpoint baseado na janela colocaria um trilho ali e espremeria o texto. As container queries do Tailwind 4 fazem o painel se medir sozinho.

Clicar num título rola o artigo, e só o artigo. O trilho rola a própria lista para manter a entrada ativa à vista sem mexer o documento embaixo de você.

O que saiu da pilha

Quatro componentes foram apagados de vez nesta release: o modal de documento, o modal de criar pasta, a antiga barra lateral de sumário e uma página de documentação em lista de cards que nada mais renderizava.

O editor Markdown continua sendo o @uiw/react-md-editor, mas a estilização dele agora vem dos mesmos design tokens do resto do Archyl. Claro e escuro são um único conjunto de regras em vez de um bloco de overrides por tema empilhado sobre o da própria biblioteca.

Os anexos não mudaram e funcionam exatamente como antes: solte um arquivo no editor, cole uma captura de tela ou use Anexar. As imagens são incorporadas ao texto, todo o resto aterrissa no painel de anexos, e o contador do clipe no cabeçalho da página leva você até lá num pulo. A história completa está em Arraste, solte, pronto: os arquivos chegam aos docs do Archyl.

Por que se dar ao trabalho de redesenhar uma caixa de texto

O trabalho do Archyl é manter o modelo de arquitetura fiel ao código, e a discovery faz essa parte sozinha. A prosa em volta do modelo não recebe ajuda nenhuma desse tipo. O ADR que explica por que a fila está ali, a página de onboarding, o runbook: esses só continuam verdadeiros porque alguém segue escrevendo, e as pessoas escrevem menos quando a superfície de escrita briga com elas.

Um modal era um pequeno imposto cobrado absolutamente toda vez. Ele acabou.

Entre na sua conta, abra Docs em qualquer projeto e pressione E numa página. Não há nada para ativar e nenhum passo de migração: suas páginas, pastas e anexos estão onde você os deixou. O guia do recurso está em Documentação e ADRs.