Have an option to disable Redoc URL hash or to add a preffix to it
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
We've been using ReDoc for some time, but now we have a requirement to embedded it inside one of our applications, but this application uses HashRouter, so when we access ReDoc, it's rewriting the URL removing the existing hash, which leads to an unknown route.
Example: http://localhost/#/docs/ gets rewritten to http://localhost/#/paths/~1something~1/get.
It would be nice to have an option to disable ReDoc URL hash and, maybe, an option to add a URL hash prefix, to be added between the hash (#) and the ReDoc path ( http://localhost/#/docs/paths/~1something~1/get).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating ReDoc's URL-hash handling and the entry point that updates navigation state; the issue names no specific files or tests. Confirm how HashRouter URLs are currently rewritten, then define and verify options to disable the ReDoc hash or insert a prefix while preserving the host application's route.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100