ReadMe

2.5K posts

ReadMe banner
ReadMe

ReadMe

@readme

Turn documentation into adoption. Build interactive docs that onboard users, scale with your product, and work for AI agents.

SF / Remote Katılım Eylül 2013
68 Takip Edilen2.5K Takipçiler
ReadMe
ReadMe@readme·
ReadMe CLI — Write and lint docs from your terminal. Catches broken links, duplicate slugs, invalid frontmatter, and broken MDX. Auto-fixes most issues, and works with Claude or Codex for the rest. Write from ReadMe's editor, your IDE, or the CLI. Your customers just see great docs. Learn about the ReadMe CLI: readme.com/blog/cli
GIF
English
0
0
0
231
ReadMe
ReadMe@readme·
AI Writer — When your team pushes code changes to GitHub, ReadMe creates a branch with suggested doc updates for you to review and merge. Docs stay current with product development without the manual chase. Connect your repo to get started: readme.com/blog/ai-writer
ReadMe tweet media
English
1
0
1
392
ReadMe
ReadMe@readme·
We redesigned ReadMe from the ground up. Here's what's new: 1. Simpler admin interface that's easier to navigate 2. AI-native editor with Markdown + MDX that keeps you in the loop 3. AI Writer that watches your GitHub commits and creates docs from them 4. CLI tool for working with docs locally 5. A new homepage that shows how it all fits together
ReadMe tweet media
English
2
0
12
1.1K
ReadMe
ReadMe@readme·
We’re shipping something big tomorrow. Here’s a little hint 👀
GIF
English
0
0
14
1.7K
ReadMe
ReadMe@readme·
You're all still repping last year's swag and we love it 💙 Great seeing everyone at @writethedocs. This year's batch is coming off the printer hot!
ReadMe tweet mediaReadMe tweet media
English
0
0
2
290
ReadMe
ReadMe@readme·
We’re at @writethedocs in Portland this week so swing by to say hi, grab a custom engraved notebook, collect a few pins and a tote bag! 🦉
ReadMe tweet media
English
0
0
1
213
ReadMe
ReadMe@readme·
Your AI Dropdown now shows MCP connection options. If your project has MCP enabled, developers browsing your docs can connect their AI tools right from the page. No hunting for URLs or setup instructions. Enable it in your AI settings to try it out!
English
2
0
1
191
ReadMe
ReadMe@readme·
Your API Reference now supports CSV and plain text request body examples. Full coverage for application/json, application/x-www-url-formencoded, text/csv, application/csv, and text/plain. One of our most requested features, now live. 🚀
ReadMe tweet media
English
0
0
1
404
ReadMe
ReadMe@readme·
ReadMe's Agent just got a major upgrade. Agent multi-page edits is now live. Instead of editing one page at a time, the agent can now make changes across your entire docs at once. Try it with one of these prompts: - Replace all instances of 'whitelist' and 'blacklist' with 'allowlist' and 'blocklist' - Find every page missing a code example and list them by section - Replace all instances of [Old Brand] with [New Brand] across the docs Big refactors just got a lot faster.
English
0
0
0
339
ReadMe
ReadMe@readme·
Not every doc update starts with a code change. Sometimes you just need to edit a description, add a note, or update a detail. The ReadMe MCP server lets you do this right from your IDE. A few prompts to try in your docs: 🔍 Update our docs to say the Agent uses Opus 4.6" 📝 Add a note about the new rate limit to our API reference 🔑 Rewrite the authentication section to mention SSO support Behind the scenes it creates a new branch from your live docs, applies and verifies your changes, and returns a review link so you can preview and merge. Like a pull request for your docs, without managing any of it yourself.
English
1
0
1
237
ReadMe
ReadMe@readme·
Cluttered sidebar? We fixed that. Enable Collapsible Categories to tuck away subpages and only surface them when your customers actually need them. Here's how to do it: Admin Settings → Page Navigation → Collapsible Categories ✅ Instant before-and-after. ✨
English
0
0
3
274
ReadMe
ReadMe@readme·
Developers are building in Cursor, Claude, and VS Code. Is your API connected and accessible? Generate an MCP server from your @readme docs in 3 steps so AI agents can search and execute your API directly inside their workflow. Check out the walkthrough in the comments below.
ReadMe tweet media
English
3
0
2
228