ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 aperta il 19 ott 2019

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)JavaScript (905 fork)batch import
documentationgeneralhelp wanted

Metriche repository

Star
 (6136 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Controlla la configurazione del router del sito di documentazione (probabilmente nel file di ingresso dell'app o nella configurazione delle route). Cerca una riga come `history: createHashHistory()` e sostituiscila con `history: createBrowserHistory()`. Assicurati che il server web sia configurato per gestire il routing lato client (ad esempio, reindirizzando tutte le richieste a index.html).
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85