feedmereadmes icon indicating copy to clipboard operation
feedmereadmes copied to clipboard

Published 20 hours ago • verified publisher icon LappleApple

Please review docs about Schleuder and related projects

Open geor-g opened this issue 5 years ago • 1 comments

Hi,

We would like to ask for a review of the docs of Schleuder, a GPG-enabled mailing list manager with resending capabilities, and related projects:

  • https://0xacab.org/schleuder/schleuder
  • https://0xacab.org/schleuder/schleuder-cli
  • https://0xacab.org/schleuder/schleuder-web
  • https://0xacab.org/schleuder/schleuder-website

Thanks in advance, and for your work.

Cheers, Georg

geor-g avatar Jul 19 '18 11:07 geor-g

Thanks for the submission. :)

LappleApple avatar Jul 19 '18 13:07 LappleApple

Hiya: Finally had a chance to take a look at your Readme -- per the Readme for this project, full docs reviews aren't in scope. : ) Your Readme is pretty good! Here's what I liked:

  • states clearly at the top what it is/does
  • requirements section is prominent
  • lots of sensible links to sub-pages vs. storing everything in the Readme
  • points people to the contributing.md to encourage community

I might combine the Todo and Contributing sections, adding some contact info — including the link to this page would be sufficient. And on your mission statement page (like this a lot), you could elaborate on your governance model and decision-making processes to help contributors understand your ways of working.

LappleApple avatar Mar 21 '23 14:03 LappleApple

Closing this issue as I provided a response. Feel free to reopen if necessary. :)

LappleApple avatar Mar 28 '23 09:03 LappleApple