Commit Graph

15 Commits

Author SHA1 Message Date
Lauryn Menard
45d4df8dc2 help: Fix Markdown syntax for setting no default code block language. 2025-08-07 16:53:19 -07:00
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
e4166af617 help: Fix code block indention in markdown instruction tabs.
Our custom code fence parser for Python-Markdown does not nest
fenced code blocks inside list items, but it can be done with
4-space indented code blocks, as long the list item itself also
uses 4-space indentation.
2025-06-30 11:12:00 -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
b96d94f679 docs: Update sections for organization settings tab changes.
Updates help center, integration and contributor docs where for
the new subsections on the organization settings tab, which were
changed in #33605.

Previously, these settings were all in the "Other settings"
subsection for that organization settings tab.
2025-02-24 18:14:21 -08:00
Emil Grehn
74f1b505ba message_quoting: Rename help page to "Quote or forward a message".
Move the page to /help/quote-or-forward-a-message and
add a url redirect from the old url.

Fixes #31953
2024-12-04 22:25:14 -08:00
Emil Grehn
58d91dacd5 message_quoting: Rename 'Quote and reply' to 'Quote message'.
'Quote message' is a more accurate decription, as this option inserts
the quoted text into whatever message you're composing or editing;
it does not necessarily start a new reply.

Fixes first part of #31953.
2024-12-04 22:25:14 -08:00
Lauryn Menard
f325a7667a help: Add comma to all uses of "e.g." in help center docs. 2024-07-05 15:36:24 -07:00
Alya Abbott
53ad0e4218 help: Add example playground URL templates.
Fixes #29067.

Co-authored-by: Rohan Sharma <rs545837@gmail.com>
2024-03-13 11:29:45 -07:00
Alya Abbott
d8848057ef playgrounds: Replace replit playground example with Rust playground.
Passing code to replit as a URL parameter no longer works.
2024-02-23 09:03:44 -08:00
Alya Abbott
1062b64149 help: Explain smart formatting buttons in more detail. 2023-12-06 16:17:35 -08:00
David Rosa
6b94b1183f help: Document new formatting buttons.
Updates icons and adds instructions for formatting text using the new
formatting buttons in the compose box.

Fixes #27850.
2023-12-06 16:17:35 -08:00
Zixuan James Li
000761ac0c realm_playgrounds: Replace url_prefix with url_template.
Dropping support for url_prefix for RealmPlayground, the server now uses
url_template instead only for playground creation, retrieval and audit
logging upon removal.

This does the necessary handling so that url_template is expanded with
the extracted code.

Fixes #25723.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-07-24 17:40:59 -07:00
David Rosa
9c3efa6880 help: Update Message formatting section and page on code blocks. 2023-03-30 09:39:35 -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