Slacker News Slacker News logo featuring a lazy sloth with a folded newspaper hat
  • top
  • new
  • show
  • ask
  • jobs
Library

Comment by WillAdams

1 day ago

I found it helpful in thinking about code and the approach for my current project:

https://github.com/WillAdams/gcodepreview

In particular, it made it seem obvious to split up the documentation between:

- Overview --- readme.md

- Tutorials --- handled in various template files

- How to Guides --- embedded in the Literate Program code

- Reference --- the indices and Command Glossary

0 comments

WillAdams

Reply

No comments yet

Contribute on Hacker News ↗

Slacker News

Product

  • API Reference
  • Hacker News RSS
  • Source on GitHub

Community

  • Support Ukraine
  • Equal Justice Initiative
  • GiveWell Charities