ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 geöffnet am 19. Okt. 2019

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (905 Forks)batch import
documentationgeneralhelp wanted

Repository-Metriken

Stars
 (6.136 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die Router Konfiguration der Dokumentationsseite (wahrscheinlich in der Einstiegsdatei der App oder im Route Setup). Suchen Sie nach einer Zeile wie `history: createHashHistory()` und ersetzen Sie sie durch `history: createBrowserHistory()`. Stellen Sie sicher, dass der Webserver für clientseitiges Routing konfiguriert ist (z. B. indem alle Anfragen an index.html weitergeleitet werden).
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85