Tim Abbott (Jan 03 2017 at 05:34): Tim Abbott (Jan 03 2017 at 05:34):There's now a style guide for user documentation at http://zulip.readthedocs.io/en/latest/README.html#style-guide; please consult it when writing new user documentation :)
Rishi Gupta (Jan 04 2017 at 02:10):Posted 18 new tasks to polish our current docs, including bringing them into alignment with the style guide. (Prereq for these is native/near-native proficiency in English, since most of the work is improving the prose.)
Cynthia Lin (Jan 04 2017 at 03:00):If you're looking to claim one of these type of tasks, please check for unnecessary images and whether a macro could be integrated in. Checking to see whether some steps could be replaced with tips/warnings would be nice too. It'd really help, thanks in advance. :)
Tim Abbott (Jan 04 2017 at 03:04):@Cynthia Lin maybe it's worth putting that reminder in the task descriptions?
Cynthia Lin (Jan 04 2017 at 03:04):I can do that if you'd like, I'll send in a PR to zulip-gci
Tim Abbott (Jan 04 2017 at 03:06):awesome!
Tim Abbott (Jan 04 2017 at 03:06):Ping me when the PR is written (I don't get email notifications for that repo to keep my inbox sane)
Tim Abbott (Jan 05 2017 at 22:55):I just adding enforcement banning too-long lines from user documentation
Tim Abbott (Jan 05 2017 at 22:55):Ideally, everything should be under 80 characters, though we only enforce in the linter at-most-120-characters right now
Last updated: Jul 19 2022 at 08:22 UTC