In the help center, we want these two system bots to be referred
to as names: capitalize both words, no bold, no links, no "the"
before the bot's name.
Once the help center has transitioned to astro, we will look at
adding back the formatting to the title and sidebar for these
two articles: "General chat topic" and "General chat channels".
Our current conversion script does not work well with inserting
flattened steps in indented lists. Adding support for indented lists
would be non-trivial. Flattened steps are inserted either in case of
files or relative/setting links. I used this ( +)\{ regex to test for
instances where we might need to insert Flattened steps in an indented
block. Turns out saml-login-button.md is the only includes that faces
the issue only in saml-authentication.md.
There was no strong reason for these sub-lists to be ordered lists and
we decided to turn it into unordered list. Discussion at
https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20numbering.20regression/near/2232242
For included files, our conversion tool needs a file just to be an
ordered list to properly surround it with FlattenList. If there is
heading and description in the file, the conversion script will not
insert FlattenList. So, we just create two different include files in
this case, first for the heading/description and second for the ordered
list.
"Hide" is a better verb with the channel folders UI.
Also automatically hide inactive channels at 20+ susbscribed channels,
as we have more content in the left sidebar now.
In the "Reading strategies" and "Getting started with Zulip"
articles, we inline the h4 headers that were directly followed by
h3 headers.
Moves the shared content in those two files to the existing
`help/include/reading-conversations` file that was already being
used for the relevant content sections in those two articles.
Fixes
https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20Includes.20inside.20list.20item
The macro works fine for the current help center. But for the new help
center, the macro has a paragraph tag already, when it is part of a list
item, the margin inserted by starlight causes spacing issue. We can
override the margin for this specific case when we have the ability to
modify the MDX directly. Issue for that: #35407. Until then, we remove
this macro since it's only used it two places to have proper spacing.
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.
Partially fixes#35130.
We will still need to do a second check before the cutover, but this
commit does most of the work before the cutover happens.
The comparison was done manually.
Added comment to sidebar index should help update these changes to astro
config, although we will not solely rely on people reading that. A
second check before cutover would be prudent.
These links do not work for the general help center docs as there
is no Zulip organization for the relative link to go to. Instead
we link to other help center documentation that's relevant to the
context of these articles.
This commit adds option in personal settings to allow
navigation of channel links in left sidebar to the top
unread topic in that channel.
In cases of no unread messages in unmuted topics of the channel,
it falls back to the top topic of channel.
Fixes#35066
For mobile features that were documented and implemented for the legacy
React Native app, adds back a tabbed block for mobile with a note to
use the web app instructions in a mobile device browser, and with a
link to the Flutter GitHub issues tracking implementing the feature in
the new mobile app.
If the feature is a mobile only feature, then adds the link to the
Flutter GitHub issue in a warning note.
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.
The conversion script for help-beta assumes that all items in a numbered
list start with 1. which was a wrong assumption. This commit attempts to
fix that. We are not introducing any lint step to tackle this since it
will be easy to just check for this again before the cutover happens.
We do not change this for `numbered-list-examples.md` since that example
shows how the current numbered lists work and we might still want to
show that. We can decide what to do with that file once the time of
cutover arrives.
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.
Also, updates the options in 'Filter by topic status'
for the web app as "Unmuted topics" has been changed
to "Standard view".
Deletes static/images/help/mobile-expand-more.svg,
static/images/help/mobile-expand-less.svg, and
static/images/help/mobile-inbox-icon.svg as they are
no longer used.
Part of #34748.
