ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 opened on Oct 19, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (6,136 stars) (905 forks)batch import
documentationgeneralhelp wanted

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.

Contributor guide

Tech stack
javascripthtmlcss
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic web developmentUnderstanding of URL routing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the documentation website's source code in the repository (likely under docs/ or website/). Identify the static site generator in use (e.g., VuePress, Docusaurus) and find the configuration file where router mode is set. Change from hash to history mode, update any references to URLs without the hash, and verify all internal links still function. Check the issue comments for any additional context or constraints.