@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
redocly.com
Joined April 2018
  • Tweets407
  • Following37
  • Followers518
90Media
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 🧵
2
3
1
13
452
Start from presets adapted from the Google and Microsoft style guides, or plain language and inclusive language rules. Add them to redocly.yaml: redocly.com/docs/cli/recheck…
1
37
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.
1
2
2
7
253
Swagger 2.0 descriptions load faster and use less memory. All changes, including 0.138.1: redocly.com/docs/realm/chang…
26
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.
1
1
35
Cookie consent is built in now. Turn on consent in redocly.yaml, and analytics load only after the visitor agrees. Visitors accept, reject, or pick categories, and a Cookie preferences link in the footer lets them change their mind later.
1
27
Big docs sites need sections: guides, API reference, changelog. Navigation tabs put them in a row under the navbar, and each tab gets its own sidebar. Tabs are the top-level entries of sidebars.yaml.
1
1
35
Docs often tell readers what to ask an AI tool. Now the page can hold the prompt itself. The prompt tag shows it in a box. Readers copy it in one click or open it straight in Claude, ChatGPT, or Cursor.
1
1
72
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 🧵
1
2
1
9
356
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: redocly.com/docs/redoc/confi… Demo: redocly.github.io/redoc/ Code: github.com/Redocly/redoc
28
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.
1
34
Every operation, schema, and field gets its own link, so you can send someone straight to the field they asked about. Hash routing works on any static host. History routing gives clean URLs like /docs/events/listspecialevents.
1
33
Redoc 3 runs on the same engine as our commercial API reference. It reads OpenAPI 3.2, 3.1, 3.0, Swagger 2.0, AsyncAPI 3 and 2, GraphQL, and MCP servers described with x-mcp, and loads only the code each type needs.
1
42
If you're thinking about migrating from Spectral, here's a sign. dev.to/tatomyr/are-you-migra…

Are you migrating from Spectral? Redocly just got something to help you with that!

Spectral has been the default OpenAPI linter for years, and it did serve the community well. It made...

dev.to
2
3
49
Filter by likes and dislikes, search the questions, or export to CSV. redocly.com/docs/realm/reuni…
38
What are people actually asking your docs' AI assistant? Reunite Analytics lists every conversation. Open one to read each question and answer, with sources. Conversations your docs couldn't answer get a "No answer found" tag: your next page to write.
1
1
1
9
242
API governance like a pro? Sure. But with which linter? I put 5 of them on Stripe, GitHub, Cloudflare and friends and let the numbers talk: dev.to/albinator/openapi-lin…

OpenAPI linters: which one is the best in a real test?

Every few months somebody posts a comparison of OpenAPI linters. It is usually one number per tool,...

dev.to
3
1
4
170
Available on Enterprise and Enterprise+. How project analytics work: redocly.com/docs/realm/reuni…
51
Which AI tools read your docs, and what do they ask for? Reunite Analytics now has an MCP server section: requests, tool calls, the top tools, and the AI clients behind them, like Claude Code or Cursor.
Redocly card: "See which AI tools use your docs". A screenshot of the MCP server page in Reunite Analytics with sample data: 1,100 requests, 1,771 tool calls, and 5 MCP clients, a chart of requests and tool calls by day, a table of tools led by search, and a table of clients led by claude-code and cursor.

ALT Redocly card: "See which AI tools use your docs". A screenshot of the MCP server page in Reunite Analytics with sample data: 1,100 requests, 1,771 tool calls, and 5 MCP clients, a chart of requests and tool calls by day, a table of tools led by search, and a table of clients led by claude-code and cursor.

1
2
1
5
208
Also, the Visual review check on the PR (Pending, Approved, Changes requested) can now be switched off per project in Settings → Git hosting. redocly.com/docs/realm/reuni…
42

No more items