Redocly / Redocly/redoc

React component url prefix

Open
#1,087 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

ReDoc is wonderful project, I've started using it in production and faced this problem:
My API docs page is not alone in the project, and I want to isolate it under url #/docs/api.

But after scrolling documentation, url changes to #operation/ShopProductsGetList.
How can i specify url prefix for RedocStandalone? I want all redoc links to have this prefix like:
#/docs/api/operation/ShopProductsGetList

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the RedocStandalone entry point and trace how scrolling updates the hash URL. Determine where a configurable URL prefix could be applied to generated Redoc links. Done means links retain the requested #/docs/api prefix, including the operation URL shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.