17

No, a 33 Page README is not the better choice.

Not for reading.
Not for writing.

Compared to a /Documentation/ folder
+ good overviews / links

Comments
  • 3
    I bet you it's just one page
  • 7
    @ScriptCoded It sure is.. one looooong page
  • 1
    I've used Slate to build documentation, works quite well.
    (compiles markdown files to html via ruby inside a docker)
    What are you guys using to write long(er|ish) docs?
  • 2
    @knuppelsmurf mkdocs-material 🥰
  • 1
    THANK YOU!
    Finally someone who knows how to document.
  • 0
    I actually like single-page docs, you can reference sections with the URL hash and the browser's full-text search works by default.

    I agree that it shouldn't be in the readme and it shouldn't be edited as a single file though.
Add Comment