Asklemmy

44672 readers

844 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!

Open-ended question
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.
Not regarding using or support for Lemmy: context, see the list of support communities and tools for finding communities below
Not ad nauseam inducing: please make sure it is a question that would be new to most members
An actual topic of discussion

Looking for support?

Looking for a community?

Lemmyverse: community search
sub.rehab: maps old subreddits to fediverse options, marks official as such
[email protected]: a community for finding communities

~Icon~ ~by~ ~@Double_[email protected]~

founded 5 years ago

MODERATORS

[email protected]

What should be added to Lemmy documentation? (lemmy.ml)

submitted 2 years ago* (last edited 2 years ago) by [email protected] to c/[email protected]

15 comments fedilink hide all child comments

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

[–] [email protected] 3 points 2 years ago (1 children)

Basically divide it in two main sections: for USERS and for DEVELOPERS. The first one like a guide/manual: about how this platform works for the average user (less tech stuff), graphical content, clients, etc. And the second one like a documentation/resources module: about how the platform works in-depth (API, Frontend/Backend dev, etc.).

[–] [email protected] 2 points 2 years ago

Its already divided like that, but using "For users", "For developers" etc as section titles sounds like a good idea.