Redocly / Redocly/redoc

Add list of tags next to each method

Open
#2,324 1 comment 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

  1. I tag a given method "/entityA/create" with different labels "EntityA", "upsert", "sync", "use_caseA", "stable". ...
  2. Redoc generates the HTML properly detecting all the labels.
  3. When clicking on the "EntityA" tag, the left panel in the generated HTML opens the list of related methods, for example "/entityA/create", "/entityA/query", "/entityA/delete", ...
  4. I click on "/entityA/create" and the page scrolls down to the method. I can see all the related information except the full list of initial labels (step 1).

Additional context
IMHO, adding that list is quite useful. In the previous example the tag list will quickly feedback users with "lot of context" related to the "/entityA/create" method. (It's a sync operation, it belong to use case A, it belong to an stable. With a little bit of care using tags with the format topic.subtopic can provide a lot of information. See this example for a "plain text" document following this topic.subtopic tagging pattern (click on the "four dots" to see and play with tags).

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 by reproducing the generated HTML flow described in the issue: select a tag in the left panel, open a related method, and inspect its method detail. Trace the rendering entry point for that detail and compare it with the labels shown in the left-panel method list; done means the full initial label list is visible beside each method.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.