docs-keeper.com

Your README lies. So I built a bot that opens a docs PR every time you merge. (opens in new tab)

Discussed on DEV

The README lies. Not on purpose. It was true the day someone wrote it. Then the function got renamed, the flag got removed, the env var changed, the endpoint moved — and nobody touched the docs, because nobody's job is the docs. So the README quietly drifts away from the code, and the first person to find out is whoever copy-pastes the snippet that no longer works. If you've ever opened a doc page, scrolled to a code block, and thought "...is this still real?" — you already know the failure m...

Read the original article
Sign in to keep reading the full article.

Keyboard Shortcuts

Navigation

Next / previous post
j/k
Open post
oorEnter
Preview post
v

Post Actions

Love post
a
Like post
l
Dislike post
d
Undo reaction
u
Save / unsave
s

Recommendations

Add interest / feed
Enter
Not interested
x

Go to

Home
gh
Interests
gi
Feeds
gf
Likes
gl
History
gy
Changelog
gc
Settings
gs
Discover
gb
Search
/

General

Show this help
?
Submit feedback
!
Close modal / unfocus
Esc

Press ? anytime to show this help