Y
Hacker News
new
|
ask
|
show
|
jobs
by
cwillu
200 days ago
https://github.com/9001/copyparty/
1 comments
AdmiralAsshat
199 days ago
Good god, that's a long landing page. It's like they shoved the whole wiki into the readme.
link
jordemort
199 days ago
This is actually my favorite style of documentation. Just hit me over the head with the whole thing, I can take it.
link
medstrom
199 days ago
Plus, in my experience when I make a separate user manual... a lot fewer people read it.
link
yjftsjthsd-h
199 days ago
Yes, but it starts with an overview, table of contents, and quickstart, so I see no downsides to that approach and lots of upsides.
link
vinnymac
199 days ago
Most repositories try to create a poor man’s wiki inside of their README. It’s better this way until that problem is solved.
The other style I like is a single sentence with a single link to the actual wiki.
link