Redocly / Redocly/redoc

Linking to certain attributes

Open
#63 3 comments 8 reactions 1 assignee View on GitHub

@RomanHotsiy is already working on this.

Since Jun 29, 2016.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

I just had the idea that it would be useful to link directly to a property e.g. sometimes we get questions and we could then just say, please see the allowed_vehicle property and link it. The user would be scrolled down to the correct location and see the property highlighted 'somehow' and can read the explanation. (You did a cool job already via #56 which makes it already useful and nice for us and we will integrate it soon regardless of further features ;))

Instead the user now has to search manually through the docs to read everything and place it correctly.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.