redoc custom ui sharing is difficult.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
Compared to redocly, the open source redoc UI is outdated. And the customization options provided by redocly don't match perfectly with redoc, so it's confusing.
However, our design team wanted to customize the design, and in order to reduce the cost of communication, we developed a custom redoc with UI and developed so that it can be checked immediately.
Describe the solution you'd like
Surely there are people who have the same problem as me, and I think it would be good to use it at that time.
Describe alternatives you've considered
By providing only the customizable parts in redoc, you can check the storybook right away, and you can check the modified history as code that can be applied to React Component.
Additional context
Please check this link.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue description and the linked custom Redoc demo at redoc-customization.vercel.app. Review which Redoc UI parts are customizable and how the Storybook examples and React component change history are expected to be shared. Done should be defined as an agreed, reusable customization experience, but the issue does not specify its scope or acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, storybook, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100