2012
Never again (lemmy.world)
submitted 8 months ago by renzev@lemmy.world to c/linuxmemes@lemmy.world
you are viewing a single comment's thread
view the rest of the comments
[-] Anti_Face_Weapon@lemmy.world 27 points 8 months ago

There are so many tools to make documentation for your project. LATEX is a great one, and you can use it to easily host your documentation online. And it's really not difficult at all to do by hand. If you can have it on discord you can certainly have it in a repo.

Maybe it's a cynical ploy to increase community engagement with their project by getting them into the discord. Regardless, it gives me The Ick. Very gross.

[-] renzev@lemmy.world 37 points 8 months ago

LaTeX is great, but I prefer Markdown for software documentation (bonus points if your flavor of markdown supports LaTeX-style math). Standard LaTeX is geared towards typesetting and formatting, which is great for reports and journals, but not so much for software documentation, so you end up with a lot of boilerplate. Markdown syntax is also more accessible to beginners, I feel. And if you have a really big project that requires features like cross-references, there's things like myst markdown.

[-] Anti_Face_Weapon@lemmy.world 10 points 8 months ago

Both are powerful tools, though with different strengths as you describe. I was thinking more with automation in mind. But regardless, anything is better than a discord server. Even .txt documentation!

load more comments (7 replies)
this post was submitted on 28 Jan 2024
2012 points (98.2% liked)

linuxmemes

20901 readers
1753 users here now

I use Arch btw


Sister communities:

Community rules

  1. Follow the site-wide rules and code of conduct
  2. Be civil
  3. Post Linux-related content
  4. No recent reposts

Please report posts and comments that break these rules!

founded 1 year ago
MODERATORS