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.

  • dinomug
    411 months ago

    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.).

    • @nutomicOPA
      311 months ago

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