Redocly/redoc

Possibility to add menu items to external sites

Open

#181 opened on Jan 11, 2017

View on GitHub
 (5 comments) (4 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

Add the possibility to add menu items that points to external sites from swagger extensions or in javascript to the redoc object.

Should support nested menus.

Contributor guide

Tech stack
typescriptreactrest api
Domain
frontenddocumentation
Issue type
feature
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-2 days
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
React knowledgeTypeScript knowledgeRedoc architectureOpenAPI extensions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how Redoc currently renders menu items from the OpenAPI spec (likely in src/components/SideMenu or similar). Review comments in the issue for proposed designs. Consider implementing support for an OpenAPI extension (e.g., x external menu) or a JavaScript config object that defines external links with nested structure. Ensure nested menus are supported by modifying the menu data structure.