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 (2,272 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (21,877 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate the existing menu component in Redoc to understand how items are rendered. Determine where to add support for external URLs, possibly via swagger extensions or JavaScript configuration. Consider nested menu structure and how to differentiate internal vs external links.
Tech stack
typescriptreact
Domain
frontendapi
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptTypeScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65