20
submitted 2 years ago* (last edited 2 years ago) by nutomic@lemmy.ml to c/asklemmy@lemmy.ml

My current task is to improve the Lemmy documentation, particularly to explain things better for people who are new to Lemmy and the Fediverse. For this I would like to know if there are any things that were unclear when you first joined (or even still unclear now).

To give you some idea, these are the pages which I plan to write for the first section, with average users in mind:

  • Getting started (choose an instance, register, follow, setup profile, start posting)
  • What is federation
  • Moderation
  • Censorship resistance
  • Votes and ranking
  • Media (Markdown, images, links)
  • Other features (theming, language tags, ...)

Besides this I also plan to improve other parts of the documentation, to add things like documentation for the HTTP API (currently only exists for websocket), a guide to run Lemmy with TOR, and explanation of community/site options. Is there anything else where documentation is missing or requires clarification?

By the way, just like other parts of Lemmy the documentation is open source, and you are welcome to open pull requests with improvements.

you are viewing a single comment's thread
view the rest of the comments
[-] Helix@feddit.de 2 points 2 years ago

The API and protocol would be the most important for me. Admin documentation (how to run things) would be second on my wishlist.

[-] nutomic@lemmy.ml 3 points 2 years ago

Is there anything specific that you want the documentation to explain?

this post was submitted on 02 Apr 2023
20 points (100.0% liked)

Asklemmy

43623 readers
949 users here now

A loosely moderated place to ask open-ended questions

Search asklemmy ๐Ÿ”

If your post meets the following criteria, it's welcome here!

  1. Open-ended question
  2. Not offensive: at this point, we do not have the bandwidth to moderate overtly political discussions. Assume best intent and be excellent to each other.
  3. Not regarding using or support for Lemmy: context, see the list of support communities and tools for finding communities below
  4. Not ad nauseam inducing: please make sure it is a question that would be new to most members
  5. An actual topic of discussion

Looking for support?

Looking for a community?

~Icon~ ~by~ ~@Double_A@discuss.tchncs.de~

founded 5 years ago
MODERATORS