Redocly/redoc

Possibility to add menu items to external sites

Open

#181 geöffnet am 11. Jan. 2017

Auf GitHub ansehen
 (5 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)TypeScript (21.877 Stars) (2.272 Forks)batch import
Type: Enhancementhelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
React knowledgeTypeScript knowledgeRedoc architectureOpenAPI extensions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.