Commit Graph

11 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
Lauryn Menard
b60fc736c7 help: Use tooltip text for plus and checkmark icon descriptions. 2025-07-21 09:22:50 -07:00
Shubham Padia
35e4cf6bf6 help: Ordered list item should always be followed by an indented line.
Our help-beta conversion script expects text to be indented if the text
is part of the same list item. If it is not part of the same list item,
then it expects an empty line just after the list item. This commit
fixes existing instances for the same by searching for regex: `^1\.
.*\n(?!\n)(?!1\.)( {0,1}\S.*)`.

We do not want to add a lint rule for this, since not indenting is not
technically wrong. We will add a TODO list item in the conversion script
for help-beta in future commits.
2025-06-23 09:48:43 -07:00
Lauryn Menard
6b8f1dee2d help: Add include macros for shared mobile instructions.
Fixes #34748.
2025-06-17 11:43:49 -07:00
Lauryn Menard
7fd8acdee6 help: Reorder tabs on logging in article instructions.
Makes the mobile tab be the initial one shown for the instructions
to log in to a new organization and to switch between organizations.
2025-06-16 17:09:43 -07:00
Lauryn Menard
d0d8c76f21 help: Update section header for logging in to a new organization.
The instructions for the desktop and mobile apps for this section
are for when the user has already logged into an initial Zulip
organization, so we update the section header to be "Log in to a
new organization" instead of "Log in for the first time".

For both apps, if the user has not logged in to any Zulip
organization, then the apps default to the log in prompts, so
there is no need to add a set of instructions for that case.

Follow-up to feedback in #34869.
2025-06-16 17:09:43 -07:00
Lauryn Menard
66b8ee03b1 help: Update log in/out instructions for Flutter launch.
Part of #34748.
2025-06-16 10:03:10 -07:00
Sayam Samal
19a7dae8aa docs: Update the gear menu icon.
This commit updates the /help and /api docs to reflect the new gear
menu icon introduced in bc3d486.
2024-04-23 09:24:02 -07:00
Alya Abbott
f1e78d2135 help: Tweak instructions for finding your Zulip account. 2024-01-17 12:45:50 -08:00
David Rosa
aa207b8207 help: Fix links to production docs.
We should normally be linking to the stable version of production
documentation, unless the page/section isn't there yet.
2023-03-23 12:18:06 -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