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
Niloth P
aa117366ef help-docs: Update the subdomain manually for Zulip Cloud examples.
Update to maintain consistency with the value of the context property
used in the other docs.

We avoid using the context property for these instances because we
always want them to show "your-org.zulipchat.com" irrespective of the
domain the docs are hosted in. Hence, the manual replacements.
2025-06-20 16:04:26 -07:00
Alya Abbott
8230f394fb help: Use better example subdomain in inviting users instructions. 2024-09-20 15:30:43 -07:00
Alya Abbott
7df0db142b help: Document how to invite users in imported organizations. 2024-09-01 16:16:04 -07:00
Ujjawal Modi
54c7cbaf1c docs: Change Create an invitation link heading.
This commit changes the `Create an invitation link` heading
in help docs to `Create a reusable invitation link`.
2023-09-07 14:21:01 -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