Navegação de documentação aprimorada com uma nova barra lateral

[hugh (Hugh Lashbrooke)]

Esta semana, publicamos uma melhoria significativa na documentação do Discourse - uma nova barra lateral! Este recurso foi projetado para tornar a navegação e o acesso à nossa documentação mais fáceis e intuitivos do que nunca.

O que há de novo?

A nova barra lateral aparece em todas as categorias e tópicos de documentação, facilitando a navegação em seu conteúdo. Veja o que você pode esperar:

1. Navegação aprimorada: Com uma estrutura hierárquica clara, mover-se entre diferentes tópicos agora é mais rápido e direto.

2. Consciência contextual: A barra lateral destaca os tópicos atuais que você está visualizando, facilitando a compreensão de onde você está na documentação.

3. Seções recolhíveis: Cada seção dentro da barra lateral pode ser recolhida e expandida conforme necessário, facilitando a localização dos tópicos que você precisa.

4. Filtro em tempo real: Encontre rapidamente tópicos específicos na barra lateral digitando palavras-chave relevantes - se nada for encontrado, você será convidado a realizar uma pesquisa mais aprofundada com o mesmo prompt.

5. Amigável para dispositivos móveis: A nova barra lateral funciona perfeitamente em dispositivos móveis, com todos os mesmos recursos da visualização para desktop.

Vamos dar uma olhada

Você pode ver a nova barra lateral de documentação em ação hoje mesmo!

Aqui estão algumas capturas de tela para lhe dar uma ideia melhor do que esperar:

Como você pode ver, a barra lateral oferece uma visão geral clara de todas as seções de documentação, tornando a navegação uma brisa.

Cada categoria mostra os tópicos dentro dela, divididos em seções definidas.

O tópico que você está visualizando atualmente é destacado na barra lateral para fácil referência.

Cada seção pode ser recolhida, permitindo que você encontre o conteúdo que precisa com mais facilidade.

Seções individuais podem ser expandidas para mostrar seu conteúdo com mais clareza.

Construindo sobre melhorias recentes

Esta nova barra lateral faz parte de nossos esforços contínuos para melhorar a experiência de documentação do Discourse. Ela se baseia no trabalho recente para reestruturar a documentação para maior clareza. A nova barra lateral complementa essas melhorias estruturais, fornecendo uma interface intuitiva para navegar na documentação recategorizada.

Isso está associado à reformulação contínua do conteúdo de todos os nossos tópicos de documentação para alinhar com o guia de estilo publicado recentemente. Este é um trabalho em andamento, e você pode notar melhorias graduais à medida que avançamos.

Queremos seu feedback!

Você teve a chance de usar a nova barra lateral de documentação? Adoraríamos ouvir sua opinião! Por favor, poste suas experiências, sugestões ou quaisquer perguntas que você possa ter sobre este tópico.

Se você tiver perguntas ou feedback sobre nossos esforços gerais de documentação, por favor, nos informe neste tópico.

Obrigado por fazer parte da comunidade Discourse. Estamos animados para ver como este novo recurso aprimora sua experiência no Discourse.

[Arkshine]

Parabéns pelas novas mudanças; elas são muito legais.

• Filtro em tempo real em todas as categorias
  Sei que a forma como funciona atualmente pode ser difícil; eu teria adorado poder filtrar independentemente de quais (sub)categorias eu estou. Essa foi a primeira coisa que tentei naturalmente:

Claro, existem links para ajudar, o que é ótimo. Em vez disso, eu esperaria:

• Rolagem de conteúdo para cima ao usar Ctrl + /
  Ao usar o atalho para focar no campo de pesquisa, ele rola tanto a barra lateral quanto o conteúdo para cima. Não espero que o conteúdo role para cima aqui.
  

• Perda de consciência de contexto
  Se você usar o filtro, clicar em um tópico e, em seguida, limpar o filtro, pode não ver o tópico destacado. EDIT: Além disso, se você navegar para um tópico a partir de uma postagem.
  

• Seção recolhida não destacada ao visualizar um tópico
  Se você estiver visualizando um tópico e recolhendo as seções, acho que seria útil em termos de contexto destacar a seção de alguma forma ou simplesmente enfatizá-la.

[ondrej]

Ótima adição/melhoria!

É muito mais simples de navegar, pois é muito mais óbvio onde procurar

Uma pequena observação é a ordem das categorias em relação à ordem na barra lateral de navegação.

Em Documentation, as últimas 3 categorias são:

Documentation > Migrating to Discourse
Documentation > Contributing
Documentation > Developer Guides

No entanto, na barra lateral de navegação, Documentation > Developer Guides e Documentation > Contributing estão trocados.

Ótimo trabalho!

[JammyDodger]

Eles devem estar em ordem correspondente?

Onde você está vendo a ordem alternativa?

[ondrej]

Estou no celular.

[JammyDodger]

Que estranho. Não sei por que o seu está um pouco diferente.

Veja o que eu vejo:

Você também não parece ter uma descrição de categoria de guia do desenvolvedor na caixa. Você silenciou a categoria ou algo assim?

[manuel (Manuel Kostka)]

Posso ativar uma barra lateral de categoria como essa em outras instâncias?

[Moin]

É um Theme component GitHub - discourse/discourse-docs-sidebar.

[ondrej]

@JammyDodger

Você silenciou a categoria ou algo assim?

Ahh, era isso, problema resolvido!

[mcwumbly (Dave McClure)]

@manuel

Posso ativar uma barra lateral de categoria assim em outras instâncias?

@Moin

É um Theme component GitHub - discourse/discourse-docs-sidebar .

Sinta-se à vontade para experimentar, mas ainda há muito a ser feito para que isso seja algo que estejamos preparados para oferecer suporte total.

Há uma quantidade considerável de sobrecarga envolvida na manutenção dos tópicos do índice, que é o que impulsiona a interface do usuário para a barra lateral, e nenhum sistema integrado para garantir que eles permaneçam consistentes com os tópicos da categoria.

Estamos aceitando essa sobrecarga para manter a documentação aqui por enquanto, com foco na coleta de feedback das pessoas sobre a experiência de leitura e navegação na documentação aqui. Estamos procurando esse tipo de feedback agora, mais do que feedback sobre como é manter a documentação usando este componente.

[Heliosurge (Dan DeMontmorency)]

Isso é muito bom mesmo. Aguardando ansiosamente por um lançamento completo.

[Jagster (Jakke Lehtonen)]

É muito mais fácil de usar do que o antigo. Mais… claro. Mas aposto que os mais orientados tecnicamente podem achá-lo limitante.

Eu não uso documentação, mesmo quando preciso, porque meus usuários têm medo de filtros. Este sistema seria mais amigável.

Mas se precisar de amor e atenção constantes do lado do administrador…

[hugh (Hugh Lashbrooke)]

@Arkshine

Conteúdo rolando para cima ao usar Ctrl + /
…
Perda de consciência de contexto
…
Seção recolhida não é destacada ao visualizar um tópico

Obrigado por observar isso, @Arkshine! Todos esses problemas devem ser corrigíveis, então veremos o que podemos fazer aqui.

[Moin]

De alguma forma, a barra lateral de documentação altera o funcionamento da pesquisa. No meu tablet, não consigo usar a tecla Enter para obter os resultados da pesquisa quando a barra lateral de documentação está visível. Notei que diz ‘next’ em vez de ‘go’, mas não sei porquê.

[saquetim (Sérgio Saquetim)]

Não consigo reproduzir o problema.

Acabei de tentar no meu iPad.

Você pode verificar se ainda está acontecendo?

[Moin]

Ainda está acontecendo. Consigo reproduzir no Chrome e no Edge, mas não usando o aplicativo Firefox.

[saquetim (Sérgio Saquetim)]

Ainda não consigo reproduzir. Não vejo como a barra lateral de documentação poderia estar causando isso.

Ela não altera nenhum código de pesquisa.

Pode ser outra coisa.

Você pode fornecer mais detalhes sobre a configuração que está usando? Versão do navegador, SO, etc.

[Moin]

Galaxy Tab S9 FE
Android 14; SM-X510 Build/UP1A.231005.007
Chrome 126.0.6478.123

Tentei o teclado externo. Isso me ajudou a determinar que a tecla Enter aparentemente precisa ser pressionada uma segunda vez.

[saquetim (Sérgio Saquetim)]

Ok, consigo reproduzir no Android.

Não é apenas a barra lateral de documentação, o mesmo acontece com a barra lateral de administração.

Precisaremos investigar o problema.

Já sei o que está acontecendo.

Discutiremos a melhor correção internamente.

[saquetim (Sérgio Saquetim)]

O problema deve ser resolvido por:

DEV: Added enter hints for the quick search and sidebar filter

Já está ativo no Meta