Toggle de publicacao

Passo 1. Toggle de publicacao — cada pagina tem um icone de olho que funciona como toggle de visibilidade. Quando o olho esta aberto (visivel), a pagina esta publicada e acessivel no guia publico. Quando o olho esta fechado (riscado), a pagina esta em rascunho e so o admin a pode ver. O admin pode clicar neste icone para alternar rapidamente entre publicado e rascunho sem necessidade de abrir a pagina para edicao.

Passo 2. Botao de geracao de documentacao — no topo da pagina ou na barra de accoes existe um botao "Gerar" ou "Regenerar" que inicia o processo de geracao automatica de documentacao. Este processo le os metadados e screenshots gerados pelos testes E2E (guardados em publichttps://dev.platform.inallweb.com/docs-assets/) e cria paginas de documentacao formatadas com texto descritivo e imagens. O processo pode demorar alguns segundos dependendo do numero de suites de testes existentes.

Passo 3. Link de pre-visualizacao — cada pagina na tabela tem um link ou botao de preview que abre a pagina de documentacao no guia publico numa nova tab do browser. O URL segue o formato /guide/slug-da-pagina. O admin pode usar esta funcionalidade para verificar como a pagina aparece para os utilizadores finais antes de a publicar. A pre-visualizacao mostra o conteudo completo incluindo texto, screenshots e navegacao lateral.

Passo 4. Pagina inicial do guia de utilizador — o ecra de entrada do guia mostra o titulo "Guia de Utilizador" com um icone de livro no topo. Abaixo do titulo existem cartoes de categoria que organizam a documentacao em seccoes logicas. Esta pagina e o ponto de entrada para todos os utilizadores (publicos, clientes e administradores) que precisam de ajuda para usar a plataforma. O design e limpo e intuitivo, adaptando-se ao tema escuro ou claro do sistema.

Passo 5. Detalhe da pagina inicial — os cartoes de categoria mostram: Site Publico (com o numero de paginas sobre a landing page, produtos, precos e checkout), Portal do Cliente (paginas sobre dashboard, servicos, facturas e tickets) e Painel Admin (paginas sobre gestao de clientes, produtos, facturacao e configuracoes). Cada cartao tem um icone representativo, o nome da categoria e o numero de paginas disponiveis. O utilizador clica num cartao para ver os topicos dessa seccao.

Passo 6. Navegacao lateral (sidebar) do guia — no lado esquerdo do ecra existe uma barra lateral com um campo de pesquisa no topo e uma arvore de topicos organizada por categoria. Cada categoria (Publico, Cliente, Admin) pode ser expandida para revelar os topicos disponiveis. Os topicos sao clicaveis e levam directamente a pagina de documentacao correspondente. A sidebar mantem-se visivel durante a navegacao para facilitar a exploracao de diferentes topicos.

Passo 7. Funcionalidade de pesquisa — ao digitar no campo de pesquisa (por exemplo, "login"), o sistema filtra os topicos em tempo real mostrando apenas os que contem o termo pesquisado no titulo ou conteudo. A pesquisa funciona de forma instantanea sem necessidade de clicar num botao. Os resultados aparecem na sidebar substituindo a arvore de topicos normal. Para limpar a pesquisa basta apagar o texto do campo.

Passo 8. Resultados da pesquisa — cada resultado mostra o titulo do topico e um excerto (snippet) do conteudo que corresponde ao termo pesquisado. Os resultados sao clicaveis e levam directamente a pagina de documentacao. Se nao houver resultados, o sistema mostra uma mensagem indicando que nenhum topico foi encontrado. A pesquisa e insensivel a maiusculas e minusculas e procura em todos os campos do topico incluindo titulo, descricao e conteudo.

Passo 9. Navegacao para um topico — ao clicar num topico na sidebar, o conteudo principal do ecra actualiza-se para mostrar a pagina de documentacao selecionada. O topico activo fica destacado na sidebar com uma cor diferente (amarelo no tema escuro, azul no tema claro) para indicar a posicao actual do utilizador na arvore de documentacao. A transicao e suave e o URL actualiza-se para reflectir a pagina actual, permitindo partilhar links directos.

Passo 10. Conteudo da pagina de documentacao — a area principal mostra breadcrumbs (migalhas de pao) no topo para navegacao hierarquica (ex: Guia > Admin > Configuracoes), seguidos do titulo da pagina, a versao e a data de ultima actualizacao. Abaixo surge o conteudo em formato markdown renderizado com titulos, paragrafos, listas e screenshots intercalados. Os screenshots sao capturas de ecra geradas automaticamente pelos testes E2E e ilustram cada passo descrito no texto.

Passo 11. Toggle de publicacao — cada pagina tem um icone de olho que funciona como toggle de visibilidade. Quando o olho esta aberto (visivel), a pagina esta publicada e acessivel no guia publico. Quando o olho esta fechado (riscado), a pagina esta em rascunho e so o admin a pode ver. O admin pode clicar neste icone para alternar rapidamente entre publicado e rascunho sem necessidade de abrir a pagina para edicao.

Passo 12. Botao de geracao de documentacao — no topo da pagina ou na barra de accoes existe um botao "Gerar" ou "Regenerar" que inicia o processo de geracao automatica de documentacao. Este processo le os metadados e screenshots gerados pelos testes E2E (guardados em publichttps://dev.platform.inallweb.com/docs-assets/) e cria paginas de documentacao formatadas com texto descritivo e imagens. O processo pode demorar alguns segundos dependendo do numero de suites de testes existentes.

Passo 13. Link de pre-visualizacao — cada pagina na tabela tem um link ou botao de preview que abre a pagina de documentacao no guia publico numa nova tab do browser. O URL segue o formato /guide/slug-da-pagina. O admin pode usar esta funcionalidade para verificar como a pagina aparece para os utilizadores finais antes de a publicar. A pre-visualizacao mostra o conteudo completo incluindo texto, screenshots e navegacao lateral.

Passo 14. Pagina inicial do guia de utilizador — o ecra de entrada do guia mostra o titulo "Guia de Utilizador" com um icone de livro no topo. Abaixo do titulo existem cartoes de categoria que organizam a documentacao em seccoes logicas. Esta pagina e o ponto de entrada para todos os utilizadores (publicos, clientes e administradores) que precisam de ajuda para usar a plataforma. O design e limpo e intuitivo, adaptando-se ao tema escuro ou claro do sistema.

Passo 15. Detalhe da pagina inicial — os cartoes de categoria mostram: Site Publico (com o numero de paginas sobre a landing page, produtos, precos e checkout), Portal do Cliente (paginas sobre dashboard, servicos, facturas e tickets) e Painel Admin (paginas sobre gestao de clientes, produtos, facturacao e configuracoes). Cada cartao tem um icone representativo, o nome da categoria e o numero de paginas disponiveis. O utilizador clica num cartao para ver os topicos dessa seccao.

Passo 16. Navegacao para um topico — ao clicar num topico na sidebar, o conteudo principal do ecra actualiza-se para mostrar a pagina de documentacao selecionada. O topico activo fica destacado na sidebar com uma cor diferente (amarelo no tema escuro, azul no tema claro) para indicar a posicao actual do utilizador na arvore de documentacao. A transicao e suave e o URL actualiza-se para reflectir a pagina actual, permitindo partilhar links directos.

Passo 17. Conteudo da pagina de documentacao — a area principal mostra breadcrumbs (migalhas de pao) no topo para navegacao hierarquica (ex: Guia > Admin > Configuracoes), seguidos do titulo da pagina, a versao e a data de ultima actualizacao. Abaixo surge o conteudo em formato markdown renderizado com titulos, paragrafos, listas e screenshots intercalados. Os screenshots sao capturas de ecra geradas automaticamente pelos testes E2E e ilustram cada passo descrito no texto.

Passo 18. Toggle de publicacao — cada pagina tem um icone de olho que funciona como toggle de visibilidade. Quando o olho esta aberto (visivel), a pagina esta publicada e acessivel no guia publico. Quando o olho esta fechado (riscado), a pagina esta em rascunho e so o admin a pode ver. O admin pode clicar neste icone para alternar rapidamente entre publicado e rascunho sem necessidade de abrir a pagina para edicao.

Passo 19. Botao de geracao de documentacao — no topo da pagina ou na barra de accoes existe um botao "Gerar" ou "Regenerar" que inicia o processo de geracao automatica de documentacao. Este processo le os metadados e screenshots gerados pelos testes E2E (guardados em publichttps://dev.platform.inallweb.com/docs-assets/) e cria paginas de documentacao formatadas com texto descritivo e imagens. O processo pode demorar alguns segundos dependendo do numero de suites de testes existentes.

Passo 20. Link de pre-visualizacao — cada pagina na tabela tem um link ou botao de preview que abre a pagina de documentacao no guia publico numa nova tab do browser. O URL segue o formato /guide/slug-da-pagina. O admin pode usar esta funcionalidade para verificar como a pagina aparece para os utilizadores finais antes de a publicar. A pre-visualizacao mostra o conteudo completo incluindo texto, screenshots e navegacao lateral.

Passo 21. Pagina inicial do guia de utilizador — o ecra de entrada do guia mostra o titulo "Guia de Utilizador" com um icone de livro no topo. Abaixo do titulo existem cartoes de categoria que organizam a documentacao em seccoes logicas. Esta pagina e o ponto de entrada para todos os utilizadores (publicos, clientes e administradores) que precisam de ajuda para usar a plataforma. O design e limpo e intuitivo, adaptando-se ao tema escuro ou claro do sistema.

Passo 22. Detalhe da pagina inicial — os cartoes de categoria mostram: Site Publico (com o numero de paginas sobre a landing page, produtos, precos e checkout), Portal do Cliente (paginas sobre dashboard, servicos, facturas e tickets) e Painel Admin (paginas sobre gestao de clientes, produtos, facturacao e configuracoes). Cada cartao tem um icone representativo, o nome da categoria e o numero de paginas disponiveis. O utilizador clica num cartao para ver os topicos dessa seccao.

Passo 23. Navegacao lateral (sidebar) do guia — no lado esquerdo do ecra existe uma barra lateral com um campo de pesquisa no topo e uma arvore de topicos organizada por categoria. Cada categoria (Publico, Cliente, Admin) pode ser expandida para revelar os topicos disponiveis. Os topicos sao clicaveis e levam directamente a pagina de documentacao correspondente. A sidebar mantem-se visivel durante a navegacao para facilitar a exploracao de diferentes topicos.

Passo 24. Funcionalidade de pesquisa — ao digitar no campo de pesquisa (por exemplo, "login"), o sistema filtra os topicos em tempo real mostrando apenas os que contem o termo pesquisado no titulo ou conteudo. A pesquisa funciona de forma instantanea sem necessidade de clicar num botao. Os resultados aparecem na sidebar substituindo a arvore de topicos normal. Para limpar a pesquisa basta apagar o texto do campo.

Passo 25. Resultados da pesquisa — cada resultado mostra o titulo do topico e um excerto (snippet) do conteudo que corresponde ao termo pesquisado. Os resultados sao clicaveis e levam directamente a pagina de documentacao. Se nao houver resultados, o sistema mostra uma mensagem indicando que nenhum topico foi encontrado. A pesquisa e insensivel a maiusculas e minusculas e procura em todos os campos do topico incluindo titulo, descricao e conteudo.

Passo 26. Navegacao para um topico — ao clicar num topico na sidebar, o conteudo principal do ecra actualiza-se para mostrar a pagina de documentacao selecionada. O topico activo fica destacado na sidebar com uma cor diferente (amarelo no tema escuro, azul no tema claro) para indicar a posicao actual do utilizador na arvore de documentacao. A transicao e suave e o URL actualiza-se para reflectir a pagina actual, permitindo partilhar links directos.

Passo 27. Conteudo da pagina de documentacao — a area principal mostra breadcrumbs (migalhas de pao) no topo para navegacao hierarquica (ex: Guia > Admin > Configuracoes), seguidos do titulo da pagina, a versao e a data de ultima actualizacao. Abaixo surge o conteudo em formato markdown renderizado com titulos, paragrafos, listas e screenshots intercalados. Os screenshots sao capturas de ecra geradas automaticamente pelos testes E2E e ilustram cada passo descrito no texto.