ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 aberto em 19 de out. de 2019

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (905 forks)batch import
documentationgeneralhelp wanted

Métricas do repositório

Stars
 (6.136 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

It seems that the doc website is using a router in hash mode. For example, URL of the index of the reference section is https://learn.ml5js.org/docs/#/reference/index. There is a hash tag "#" in the URL.

This may make it a little obfuscating for people who want to memorize the link and share it with others.

I recommend changing the router from hash mode to history mode to remove the ugly hash tag.

Guia do colaborador

Direção de pesquisa
Verifique a configuração do roteador do site de documentação (provavelmente no arquivo de entrada do aplicativo ou na configuração de rotas). Procure por uma linha como `history: createHashHistory()` e substitua por `history: createBrowserHistory()`. Certifique se de que o servidor web esteja configurado para lidar com roteamento do lado do cliente (por exemplo, redirecionando todas as solicitações para index.html).
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85