Twitxy Saved

Redocly

Verified account This account is verified. Learn more

@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 馃挭
Sign up at: app.redocly.com redocly.com Joined April 2018
37 Following 521 Followers 413 Posts

Latest posts 5

Pinned post

Redocly Verified account @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 馃У
0:37
3 replies 3 reposts 13 likes 540 views View on X
Redocly Verified account @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 Verified account @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.
0:48
Redocly Verified account @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 Verified account @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.