Hacker News
new
|
past
|
comments
|
ask
|
show
|
jobs
|
submit
login
AdmiralAsshat
37 days ago
|
parent
|
context
|
favorite
| on:
Copyparty, the FOSS file server [video]
Good god, that's a long landing page. It's like they shoved the whole wiki into the readme.
jordemort
37 days ago
|
next
[–]
This is actually my favorite style of documentation. Just hit me over the head with the whole thing, I can take it.
medstrom
37 days ago
|
parent
|
next
[–]
Plus, in my experience when I make a separate user manual... a lot fewer people read it.
yjftsjthsd-h
37 days ago
|
prev
|
next
[–]
Yes, but it starts with an overview, table of contents, and quickstart, so I see no downsides to that approach and lots of upsides.
vinnymac
37 days ago
|
prev
[–]
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.
Guidelines
|
FAQ
|
Lists
|
API
|
Security
|
Legal
|
Apply to YC
|
Contact
Search: