Commit Graph

74 Commits

Author SHA1 Message Date
Shubham Padia
9fa09f8f87 help: Make canonical URL for the root to be /help/.
We also make sure that /help/ is accessible when using the dev server.

We add vite as a dependency. v7 of vite is the latest version but using
that causes type problems for PluginOptions since astro uses vite v6.
Therefore we pin vite to v6 for now.

This commit also runs `pnpm dedupe` for `tinyglobby` pinning it to
0.2.15 instead of the previous 0.2.14 in the lockfile.
2025-10-06 22:21:39 -07:00
Anders Kaseorg
b742ab18f9 emoji: Remove setting for deprecated Google blobs emoji set.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-10-01 13:35:06 -07:00
Lauryn Menard
91dde7cbeb help: Update mobile instructions for browse and subscribe to channels.
Update the mobile instructions for the new all channels view that
allows users to browse and subscribe to channels on the mobile app.
2025-09-30 11:27:49 -07:00
Lauryn Menard
692e907b68 help: Add mobile instructions for deleting a message completely. 2025-09-30 11:27:12 -07:00
Tim Abbott
e217340b23 help: Shorten title for apps link.
This avoids unnecessary line-wrapping, and I think sets expectations
correctly for anyone reading this sidebar.
2025-09-26 12:21:35 -07:00
Shubham Padia
f426936c6c help: Add external link icon as suffix in sidebar for external links.
Fixes https://chat.zulip.org/#narrow/channel/19-documentation/topic/left.20sidebar.20icon.20for.20external.20links.3F/with/2257078

These links should also open in a new window.
2025-09-26 12:20:55 -07:00
Shubham Padia
8ddc7bee00 help: Make include a sibling of content/docs directory.
When moving content between the include files and the docs files while
copy pasting them, there was a need to change the imports everytime
this was done. This was inconvenient to do.

We considered path aliases to solve this problem but not all editors
support path resolution via those aliases and thus we change the
directory structure instead.

We change imports for components, include files and images in this
commit.

See
https://chat.zulip.org/#narrow/channel/19-documentation/topic/confused.20about.20include.20file
for more info.
2025-09-26 11:12:21 -07:00
Shubham Padia
3b1f4a9d09 help: Move static/images/help to starlight_help/src/images.
Astro was importing these images and doing it's own processing anyways,
there was not a reason for these images to stay in the static folder.

For channels-and-topics.png, we keep the help center directory as the
source directory for two symlinks since that is where the image is
likely to stay the longest.
2025-09-26 11:12:21 -07:00
Shubham Padia
310a2323b6 subscriptions: Move raw svg for plus and check icons to zulip-icon.
Fixes #35899.

We don't make any visual changes to how the svgs/icons look, we just
move them to use the zulip-icon system.

We also replace use of the raw images of each in the help center and add
appropriate color for both in the help center.
2025-09-17 14:15:05 -07:00
Tim Abbott
6a5d214be6 help: Fix linter errors in last merged PR. 2025-09-17 13:53:02 -07:00
Alya Abbott
d3ca0fc7ae docs: Revamp production doc on security.
- Remove duplicative content.
- Move content to topic-focused pages.
2025-09-17 13:28:02 -07:00
Alya Abbott
be0fc99b58 help: Organize details on bots overview page.
Also document can_forge_sender permission.
2025-09-17 13:27:16 -07:00
Alya Abbott
9e3fea7ed3 help: Add a note about DMs privacy model. 2025-09-17 13:27:16 -07:00
Alya Abbott
10ce39a82c help: Add links to releated articles. 2025-09-17 13:27:16 -07:00
Alya Abbott
9b1c7f761a help: Document logging out by resetting API key and password. 2025-09-17 13:27:16 -07:00
Alya Abbott
f1f9769a08 help: Add a page on protecting your account. 2025-09-17 13:27:16 -07:00
Alya Abbott
0edacce98e help: Update password reset instructions for new UI. 2025-09-17 13:27:16 -07:00
Sahil Batra
683eca97a7 stream-settings: Replace "Not subscribed" tab with "Available".
This commit replaces "Not subscribed" tab in stream settings
with "Available" tab where only streams which the user can
subscribe to are shown.

Fixes #35919.
2025-09-16 11:16:06 -07:00
Shubham Padia
35c6dec2b9 help: Ensure trailingSlash is set to never.
Sidebar links were adding a trailing slash to each of the pages. Our
canonical URLs don't have a trailing slash. This will probably also stop
starlight from adding trailing slash at other unexpected places.

When running the astro dev server, if a page has a trailing slash, we
will get a page from astro asking to remove that slash. That will not
happen in static build mode or production since we don't use astro's
serving mechanisms there.
2025-09-11 13:46:58 -04:00
Shubham Padia
57b7ada2e4 help: Pre compress astro build files before serving.
This way nginx doesn't have to compress it every time.
2025-09-11 10:50:10 -04:00
Anders Kaseorg
473c8fa81a starlight_help: Downgrade sharp to the version Astro expects.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-10 16:33:41 -07:00
Anders Kaseorg
01c3f714c6 remark: Type-check Remark configuration.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-10 09:44:44 -07:00
Anders Kaseorg
3163805b92 astro: Type-check Astro configuration.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-10 09:44:44 -07:00
Anders Kaseorg
57e8c44e81 starlight_help: Use ‘astro check’ for development only.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-10 09:44:44 -07:00
Alya Abbott
6027344ad5 help: Add more links to self-hosted export instructions. 2025-09-09 09:18:41 -07:00
Shubham Padia
daec793b9d help: Insert headings inside import for ReadingConversations.
Fixes #35127.

Headings inside the import will not be rendered anywhere, but the `On
this page` component on the right needs those headings in the main file
to read it and then make it a part of `On this page`.

We have skipped includes with `What you type` and `What it looks like`
in them as we don't need to show them in the `on this page` overview.

We have skipped adding any headings with four hashes `####`, since they
do not appear in `on this page`
overview.`ImportIntoAZulipCloudOrganization` and
`ImportIntoASelfHostedServerDescription` are two examples of this.

See https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20on.20this.20page.20overview/near/2249466
2025-09-08 14:29:08 -07:00
Shubham Padia
22605a3f14 help: Insert headings inside import for ImportHowUsersWillLogIn.
Headings inside the import will not be rendered anywhere, but the `On
this page` component on the right needs those headings in the main file
to read it and then make it a part of `On this page`.

See https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20on.20this.20page.20overview/near/2249466
2025-09-08 14:29:08 -07:00
Shubham Padia
4196a17024 help: Insert headings inside import for AutomaticallyFollowTopics.
Headings inside the import will not be rendered anywhere, but the `On
this page` component on the right needs those headings in the main file
to read it and then make it a part of `On this page`.

See https://chat.zulip.org/#narrow/channel/19-documentation/topic/new.20help.20center.3A.20on.20this.20page.20overview/near/2249466
2025-09-08 14:29:08 -07:00
Alya Abbott
5759d90629 help: Remove unnecessary "with Zulip". 2025-09-08 11:49:07 -07:00
Anders Kaseorg
6615756437 lint: Don’t auto-fix with remark unless requested.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 13:13:37 -07:00
Alya Abbott
3ad0db8c05 help: Add a dedicated sidebar section for advanced guides. 2025-09-04 12:15:24 -07:00
Alya Abbott
b2819dd92f help: Create new help center home page. 2025-09-04 12:15:24 -07:00
Anders Kaseorg
083464fb16 remark: Don’t exclude remark-lint-list-item-indent.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 11:30:43 -07:00
Anders Kaseorg
f191a250ac remark: Override markdown-style-guide preset with recommended.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 11:30:43 -07:00
Anders Kaseorg
1c085b1d77 remark: Don’t exclude remark-lint-no-duplicate-definitions.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 11:04:02 -07:00
Anders Kaseorg
1178048a08 format-mdx: Add remark-gfm.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 10:27:47 -07:00
Anders Kaseorg
e4960a7595 help: Put your-org link in a code span.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 10:27:47 -07:00
Anders Kaseorg
2e805be1d8 help: Fix misformatted MDX.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-04 10:27:47 -07:00
Lauryn Menard
6a81aba20e help: Fix find direct message conversation tabbed sections. 2025-09-04 09:19:22 -07:00
Alex Vandiver
b4e06a6fa0 help: Uploads do not default to containing the hostname in the link. 2025-09-03 22:39:55 -07:00
Alex Vandiver
4f02f04682 help: Always use your-org.zulipchat.com for Zulip Cloud example URLs. 2025-09-03 22:39:55 -07:00
Alex Vandiver
9fdeddb773 help: Add language and highlight markers. 2025-09-03 22:39:55 -07:00
Alex Vandiver
968dfc5a28 help: Fix the mailto: link in org deactivation. 2025-09-03 22:39:55 -07:00
Alex Vandiver
049ff0b71f help: Remove incorrect escaping, which broke table rendering. 2025-09-03 22:39:55 -07:00
Alex Vandiver
8bf5aa04d6 help: Fix broken spoiler example. 2025-09-03 22:39:55 -07:00
Alex Vandiver
dabe0cc6d6 help: Fix broken LaTeX examples. 2025-09-03 22:39:55 -07:00
Alex Vandiver
78055633d3 help: Fix broken blockquote examples. 2025-09-03 22:39:55 -07:00
Alex Vandiver
9abc3e635a help: Fix broken "Schedule a reminder" steps. 2025-09-03 22:39:55 -07:00
Alex Vandiver
912d1d819c help: Remove incorrect brace escaping. 2025-09-03 22:39:55 -07:00
Anders Kaseorg
3d510601e5 help: Normalize and sort MDX import statements.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-03 22:36:42 -07:00