Commit Graph

6 Commits

Author SHA1 Message Date
Shubham Padia
7ce87c66ac help: Make loose lists tight for help center files.
In our current implementation, loose lists and tight lists look the same
visually. Loose lists are lists with blank lines between list items, and
the contents of a list item should be enclosed in a paragraph tag in
that case. For unordered lists, paragraph tags have a bottom margin in
starlight and thus looses lists look much more spaced out than tight
lists.

That is not the behaviour we had in mind while writing the
documentation, the reason we had all these loose lists is to make the
documentation easy to write and read. So we attempt to remove all the
blank lines and fix the problem at source. Since paragraph tags are used
for other purposes in a list in starlight, it won't be a wise decision
to let the source be as is and just change things in css, other expected
behaviours might break in that case. See this topic for more details:
https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20regressions/near/2226084

All the changes were made by a one-off script which has not been
commited to the repo. The script wasn't perfect and could not decide
between blank lines that make a list loose vs blank lines necessary for
a sub-list or a code block inside a list item. A manual review of all
the changes was done before making this commit to ensure that no
unintended changes were made to the help center files.
2025-07-22 14:36:25 -07:00
Prakhar Pratyush
a53fe206ea help: Rename remaining 'stream' to 'channel' in '/help' docs. 2024-05-06 11:18:45 -07:00
Prakhar Pratyush
6484532830 help: Migrate configure-notification-bot help page to a new URL.
This commit migrates the 'help/configure-notification-bot' help
page to a new URL i.e. 'help/configure-automated-notices'.
2024-03-20 11:48:06 -07:00
Alya Abbott
c969e11d7b help: Clarify how automated notices are translated. 2024-03-12 12:17:08 -07:00
Alya Abbott
f2b6f65f90 help: Add documentation on configuring default language for new users.
This is documented on the page about organization language, but makes sense
to include here as well.

Also reordered preferences to match the order in the menu.
2023-10-17 17:54:20 -07:00
Lauryn Menard
dedea23745 help-docs: Move help center documentation to top level directory.
These files are not Jinja2 templates, so there's no reason that they needed
to be inside `templates/zerver`. Moving them to the top level reflects their
importance and also makes it feel nicer to work on editing the help center content, 
without it being unnecessary buried deep in the codebase.
2023-01-25 14:08:29 -08:00