ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 ouverte le 19 oct. 2019

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)JavaScript (905 forks)batch import
documentationgeneralhelp wanted

Métriques du dépôt

Stars
 (6 136 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Vérifiez la configuration du routeur du site de documentation (probablement dans le fichier d'entrée de l'application ou dans la configuration des routes). Recherchez une ligne comme `history: createHashHistory()` et remplacez la par `history: createBrowserHistory()`. Assurez vous que le serveur web est configuré pour gérer le routage côté client (par exemple, en redirigeant toutes les requêtes vers index.html).
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85