3 ms·
Good god, that's a long landing page. It's like they shoved the whole wiki into the readme.
by AdmiralAsshat 11mo ago
Good god, that's a long landing page. It's like they shoved the whole wiki into the readme.
- jordemort 11mo agoThis is actually my favorite style of documentation. Just hit me over the head with the whole thing, I can take it.
- medstrom 11mo agoPlus, in my experience when I make a separate user manual... a lot fewer people read it.
- yjftsjthsd-h 11mo agoYes, but it starts with an overview, table of contents, and quickstart, so I see no downsides to that approach and lots of upsides.
- vinnymac 11mo agoMost 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.