Redocly / Redocly/redoc

Permalink on every prop and param

Open
#2,218 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

Describe the problem to be solved
I'd like to be able to send links linking to a specific property or param, instead of an endpoint.

Describe the solution you'd like
When hovering over a prop, like we do for endpoints, I'd like to see a permalink icon that copies the link automatically.

Describe alternatives you've considered
None

Additional context
None

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 locating the existing endpoint permalink hover behavior in the API reference documentation UI and compare how props and params are rendered. Add equivalent permalink icons for each prop and param, with links copied automatically, then verify that the generated links target the selected item rather than only the endpoint.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.