Redocly

Creators of Redoc & a whole suite of #API design and documentation tools for API producers and consumers. With Redocly, you can make API docs your superpower 💪

[Redocly @Redocly]

Redoc 3 is out 🚀

Point it at an API description, get docs. That hasn't changed in 10+ years. Almost everything else has: a new design, dark mode, a page for every operation, and OpenAPI, AsyncAPI, and GraphQL in one renderer.

Free and MIT licensed 🧵

[Redocly @Redocly]

Install the plugin:
https://t.co/RFd0HgVqJ9

[Redocly @Redocly]

Redocly is now in @ChatGPT 🚀

Ask it to lint your OpenAPI description and explain each problem, write a lint rule, or set up a docs site. It searches the live Redocly docs, so it looks things up instead of guessing.

[Redocly @Redocly]

Learn more: https://t.co/fLWGFgpxss

[Redocly @Redocly]

How much of your API is actually covered by your OpenAPI definition?

With drift --coverage in Redocly CLI, you can measure API coverage and identify gaps between your API and its specification.

A simple way to get better visibility into your API coverage and keep your documentation aligned with your API.

[Redocly @Redocly]

Every pull request shows its work: the signals that triggered it, the change, and the checks it passed. Leave a comment, and the agent refines the fix.

Free during early access, on GitHub for now. Request access:
https://t.co/4hi6j8ZzeW

[Redocly @Redocly]

A search that finds nothing, a question asked for the fourth time: readers keep telling you what your docs are missing.

Writer Agent reads those signals, finds the gap, fact-checks a fix against your code, and opens a pull request. You review and merge.

[Redocly @Redocly]

Start from presets adapted from the Google and Microsoft style guides, or plain language and inclusive language rules. Add them to redocly.yaml:
https://t.co/GXnK2q74GT

[Redocly @Redocly]

Most docs teams have a style guide. Few have anything that checks it.

redocly recheck lints your Markdown pages and the descriptions in your API files: repeated words, sentence-case headings, long sentences, words to avoid. --fix repairs what it can.

[Redocly @Redocly]

Swagger 2.0 descriptions load faster and use less memory.

All changes, including 0.138.1:
https://t.co/tWuhRy4CVT

[Redocly @Redocly]

Realm 0.138.0 is out 🚀

• AI prompts readers open in one click
• Navigation tabs
• Cookie consent, built in
• WebMCP, experimental

Same release for Reef, Revel, and Redoc. Highlights 🧵

[Redocly @Redocly]

Experimental: WebMCP. An AI agent in the reader's browser can search your docs and open pages through tools your site publishes, instead of guessing URLs. The reader sees every page it opens.

[Redocly @Redocly]

Upgrading from 2.x? The bundle is an ES module, the theme option is gone, and anonymous usage telemetry is on by default (disableTelemetry turns it off).

Migration guide: https://t.co/FniSsiH9bi
Demo: https://t.co/K3Fzf6rIYh
Code: https://t.co/1rFL0hifbA

[Redocly @Redocly]

Redoc 3 is out 🚀

Point it at an API description, get docs. That hasn't changed in 10+ years. Almost everything else has: a new design, dark mode, a page for every operation, and OpenAPI, AsyncAPI, and GraphQL in one renderer.

Free and MIT licensed 🧵

[Redocly @Redocly]

Theming is CSS variables now: set --color-primary-base or --sidebar-width, separately for light and dark.

Big descriptions stay fast: Redoc renders only what's near the viewport. Search is built in, and so are Copy for LLM, Open in Claude, and Open in ChatGPT.

[Albinator1707 @Albinator17071]

If you're thinking about migrating from Spectral, here's a sign.

https://t.co/8YfkxmXTiQ