zlacker

[parent] [thread] 4 comments
1. Admira+(OP)[view] [source] 2025-11-26 14:28:20
Good god, that's a long landing page. It's like they shoved the whole wiki into the readme.
replies(3): >>jordem+P2 >>yjftsj+i5 >>vinnym+8a
2. jordem+P2[view] [source] 2025-11-26 14:46:55
>>Admira+(OP)
This is actually my favorite style of documentation. Just hit me over the head with the whole thing, I can take it.
replies(1): >>medstr+6a
3. yjftsj+i5[view] [source] 2025-11-26 15:01:26
>>Admira+(OP)
Yes, but it starts with an overview, table of contents, and quickstart, so I see no downsides to that approach and lots of upsides.
◧◩
4. medstr+6a[view] [source] [discussion] 2025-11-26 15:27:56
>>jordem+P2
Plus, in my experience when I make a separate user manual... a lot fewer people read it.
5. vinnym+8a[view] [source] 2025-11-26 15:28:02
>>Admira+(OP)
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.

[go to top]