Pular para o conteúdo

Como criar as orientações de cadastro

O documento de orientações de cadastro é o recurso que o lojista utiliza para gerenciar cadastros de banners e menus no Admin da loja. Por isso, o desenvolvedor responsável pela customização da loja deve criar esse documento para auxiliar o lojista na manutenção de banners e menus da vitrine.

A criação das orientações depende dos arquivos do seu [ambiente de desenvolvimento](/guides/configuracoes-iniciais/configuracoes-iniciais). Dê um um [`pull`](https://git-scm.com/docs/git-pull) periodicamente e mantenha sua pasta [Build](https://gitlab.com/vnda/build/) sempre atualizada com o nosso repositório.

A orientação de cadastro está disponível no diretório docs do template da loja. Nesse diretório você encontra os arquivos que irão compor o documento final de orientações de cadastro da loja.

Os arquivos devem ser escritos em markdown, seguindo uma estrutura básica como no exemplo a seguir.

Exemplo de orientação de cadastro
  • Utilize h1 para títulos das páginas,:
    # Titulo da página
  • Utilizeh2 para títulos das seções:
    ## Título da seção
  • Utilize tabelas para informações sobre a seção e para as informações sobre os campos do painel administrativo:
| Dúvida | Instrução |
| --------------------- | --------------------- |
| **Onde cadastrar** | Tags |
| **Onde será exibido** | Listagens de produtos |

Para que as alterações fiquem disponíveis para visualização do lojista, lembre-se de realizar as alterações no diretório docs e rodar o comando npm run doc após a alteração dos arquivos.

O documento das orientações de cadastro deve ficar disponível para o lojista via Admin, e para isso você precisa cadastrar a URL do caminho do arquivo:

  1. Acesse o Admin;
  2. Acesse Configurações;
  3. Clique em Documentações na seção Gerais;
  4. Preencha o campo com a URL https://nomedaloja.vnda.dev/docs/index.html. Substitua o nomedaloja pelo nome da loja.
  5. Clique em Enviar.

O documento de orientação de cadastro está pronto e disponível para o lojista.