forem VS redoc

The journey of deploying an open-source software platform like forem can be complex and daunting, but with the right tools and services, it can also be remarkably rewarding. This article details my experience deploying Forem, the software behind the Dev.to, on Render.com, deploying Promptzone.com.

In the future, I think we will probs make this uniform with the others. I've logged this request here on GitHub... hmmm, maybe I should embed it here instead. 😉

I even opened a discussion, which got no responses so far (which I think existed somewhere else or I am the only one with this issue...).

Whether you're sharpening your JS skills, making PRs to your OSS repo of choice 😉, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.

Add articles clickbait_score as factor in final feed ordering #20493

Do more documentation-related and code contributions to Forem's repository

This year again, I contributed to DEV with multiples ways, I've contributed very little to the repository, moderated the bad posts quite a bit, and welcomed newcomers to the platform. I feel that a place like this should always be so welcoming to users, so why shouldn't I?

docs: making updates to Editor Guide #20258

Forem - Open Source Alternative to Circle

Whether you're sharpening your JS skills, making PRs to your OSS repo of choice 😉, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.

ReDoc Interactive Demo

ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.

There are a few other tools out there that are at least marginally better than the default Swagger UI such as ReDoc (https://github.com/Redocly/redoc).

When we redid the Mux docs (https://docs.mux.com/api-reference) we actually just decided to build our own renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.

Redoc: http://localhost:8080/redoc

ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.

take a look

Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.

FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.

Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.