News for hackers. Stuff that matters.
Re:Getting Started with Technical Writing by linsomniac on Monday November 27, 2023 @09:05AM (#38432341)
Over the last couple weeks I wrote some extensive documentation for an Open Source project, and I ended up using mkdocs published to github pages when I commit, via github-actions. That's been a really spectacular experience.

About half of the docs are just direct Markdown, and the other half are in python docstrings, pulled by mkdocs automatically. The "mkdocs serve" dev server works amazingly well for visualizing changes. Highly recommended.

Re:Getting Started with Technical Writing by dv-tw on Monday November 27, 2023 @09:37AM (#38432686)
I love working with mkdocs. I just used it for the first time this year, and I found it to be very straightforward. It allows for just the right amount of customization for my needs.