Redocly / Redocly/redoc

Make redoc RTL support

Open
#1,002 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Issue type: feature

Redoc is one of the best opensource API-docs that I have found. We(baninab.co) need an api-doc in one of our projects. What we need is an api-doc that supports RTL and has a console to test API's, so I decided to talk to @RomanHotsiy and find know how do you think about make this tool RTL support?
We are ready to start to develop redoc to make it RTL support and publish it, but I wanted to ask you to know do you have any plan to RTL support of redoc?

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 reviewing Redoc's TypeScript codebase and its API-documentation UI, then clarify whether RTL support covers the documentation view, the API console, or both. Define supported RTL behavior and acceptance criteria with maintainers before implementation. Done means the agreed Redoc surfaces render and remain usable in RTL.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend, internationalization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.