From b2819dd92f912081cd059c92702a72aa8d6bb972 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Wed, 3 Sep 2025 16:16:32 -0700 Subject: [PATCH] help: Create new help center home page. --- starlight_help/src/content/docs/index.mdx | 344 +++------------------- 1 file changed, 44 insertions(+), 300 deletions(-) diff --git a/starlight_help/src/content/docs/index.mdx b/starlight_help/src/content/docs/index.mdx index ff20530d5f..ab88940dfe 100644 --- a/starlight_help/src/content/docs/index.mdx +++ b/starlight_help/src/content/docs/index.mdx @@ -2,11 +2,16 @@ title: Zulip help center --- -Welcome to the [Zulip](/) help center! +Welcome to the help center for [Zulip organized team chat](https://zulip.com)! +Here, you'll find up-to-date information on how to use Zulip, or administer a +Zulip organization. These pages are designed to guide you as you learn your way +around Zulip. They'll also be your go-to if you're ever unsure how something +works, or if you need to explain it to someone else. -{/* Changes to this file should be propagated to starlight_help/astro.config.mjs. */} +## Guides for new users -## Guides +The following guides will help you get started, and more can be found in the +left sidebar. * [Getting started with Zulip](/help/getting-started-with-zulip) * [Choosing a team chat app](https://blog.zulip.com/2024/11/04/choosing-a-team-chat-app/) @@ -14,308 +19,47 @@ Welcome to the [Zulip](/) help center! * [Trying out Zulip](/help/trying-out-zulip) * [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) * [Moving to Zulip](/help/moving-to-zulip) -* [Community moderation toolkit](/help/moderating-open-organizations) -* [Setting up Zulip for a class](/help/setting-up-zulip-for-a-class) -* [Using Zulip for a class](/help/using-zulip-for-a-class) -* [Using Zulip via email](/help/using-zulip-via-email) -## Getting started +## Mastering Zulip -* [Joining an organization](/help/join-a-zulip-organization) -* [Set up your account](/help/set-up-your-account) -* [Introduction to topics](/help/introduction-to-topics) -* [Starting a new topic](/help/introduction-to-topics#how-to-start-a-new-topic) -* [Finding a conversation to read](/help/finding-a-conversation-to-read) -* [Reading conversations](/help/reading-conversations) -* [Starting a new direct message](/help/starting-a-new-direct-message) -* [Replying to messages](/help/replying-to-messages) -* [Messaging tips & tricks](/help/messaging-tips) -* [Keyboard shortcuts](/help/keyboard-shortcuts) +If you're using Zulip a lot, it's worthwhile to learn workflows that will help you +spend that time efficiently. Check out: -## Setting up your organization +* [Keyboard shortcuts](/help/keyboard-shortcuts): Mastering a few keyboard + shortcuts (like N to go to the next unread topic) can speed up your + workflows. +* [Reading strategies](/help/reading-strategies): Learn different ways to + find what you want to read. +* [Mastering the compose box](/help/mastering-the-compose-box): Learn about + everything Zulip’s compose box lets you do. +* [Message formatting](/help/format-your-message-using-markdown): Learn about + quotes, spoilers, global times, and more. +* [Search filters](/help/search-for-messages/#search-filters): Learn how to find + messages based on where they were sent, whether they contain links or + attachments, and other details. -* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) -* [Create your organization profile](/help/create-your-organization-profile) -* [Create user groups](/help/create-user-groups) -* [Customize organization settings](/help/customize-organization-settings) -* [Create channels](/help/create-channels) -* [Customize settings for new users](/help/customize-settings-for-new-users) -* [Invite users to join](/help/invite-users-to-join) -* [Set up integrations](/help/set-up-integrations) +## Other resources -## Account basics +You may also want to check out: -* [Edit your profile](/help/edit-your-profile) -* [Change your name](/help/change-your-name) -* [Change your email address](/help/change-your-email-address) -* [Change your profile picture](/help/change-your-profile-picture) -* [Change your password](/help/change-your-password) -* [Configure email visibility](/help/configure-email-visibility) -* [Logging in](/help/logging-in) -* [Logging out](/help/logging-out) -* [Switching between organizations](/help/switching-between-organizations) -* [Import your settings](/help/import-your-settings) -* [Review your settings](/help/review-your-settings) -* [Deactivate your account](/help/deactivate-your-account) +* [An overview](https://zulip.com/features/) of the features available in Zulip. +* [Installation + instructions](https://zulip.readthedocs.io/en/stable/production/install.html) + for setting up a self-hosted Zulip server, and documentation on [running Zulip + in production](https://zulip.readthedocs.io/en/stable/production/index.html). +* [API documentation](https://zulip.com/api/) for writing integrations or bots + using the Zulip API. +* [Contributing + guide](https://zulip.readthedocs.io/en/stable/contributing/contributing.html), + with step-by-step instructions on how to get started contributing code to + Zulip. -## Preferences +If you have any questions that aren't answered here, [let us +know](/help/contact-support)! -* [Dark theme](/help/dark-theme) -* [Font size](/help/font-size) -* [Line spacing](/help/line-spacing) -* [Configure send message keys](/help/configure-send-message-keys) -* [Change your language](/help/change-your-language) -* [Change your time zone](/help/change-your-timezone) -* [Change the time format](/help/change-the-time-format) -* [Configure emoticon translations](/help/configure-emoticon-translations) -* [Configure home view](/help/configure-home-view) -* [Enable full width display](/help/enable-full-width-display) -* [Manage your uploaded files](/help/manage-your-uploaded-files) - -## Writing messages - -* [Message formatting](/help/format-your-message-using-markdown) -* [Mention a user or group](/help/mention-a-user-or-group) -* [Link to a channel, topic, or message](/help/link-to-a-message-or-conversation) -* [Format a quote](/help/format-a-quote) -* [Quote or forward a message](/help/quote-or-forward-a-message) -* [Emoji and emoticons](/help/emoji-and-emoticons) -* [Insert a link](/help/insert-a-link) -* [Saved snippets](/help/saved-snippets) -* [Share and upload files](/help/share-and-upload-files) -* [Animated GIFs](/help/animated-gifs-from-giphy) -* [Text emphasis](/help/text-emphasis) -* [Paragraph and section formatting](/help/paragraph-and-section-formatting) -* [Bulleted lists](/help/bulleted-lists) -* [Numbered lists](/help/numbered-lists) -* [Tables](/help/tables) -* [Code blocks](/help/code-blocks) -* [LaTeX](/help/latex) -* [Spoilers](/help/spoilers) -* [/me action messages](/help/me-action-messages) -* [Polls](/help/create-a-poll) -* [Collaborative to-do lists](/help/collaborative-to-do-lists) -* [Global times](/help/global-times) -* [Start a call](/help/start-a-call) - -## Sending messages - -* [Open the compose box](/help/open-the-compose-box) -* [Mastering the compose box](/help/mastering-the-compose-box) -* [Resize the compose box](/help/resize-the-compose-box) -* [Typing notifications](/help/typing-notifications) -* [Preview messages before sending](/help/preview-your-message-before-sending) -* [Verify a message was sent](/help/verify-your-message-was-successfully-sent) -* [Edit a message](/help/edit-a-message) -* [Delete a message](/help/delete-a-message) -* [Draft messages](/help/view-and-edit-your-message-drafts) -* [Schedule a message](/help/schedule-a-message) -* [Message a channel by email](/help/message-a-channel-by-email) - -## Reading messages - -* [Reading strategies](/help/reading-strategies) -* [Inbox](/help/inbox) -* [Recent conversations](/help/recent-conversations) -* [Combined feed](/help/combined-feed) -* [Channel feed](/help/channel-feed) -* [List of topics in a channel](/help/list-of-topics) -* [Left sidebar](/help/left-sidebar) -* [Message actions](/help/message-actions) -* [Marking messages as read](/help/marking-messages-as-read) -* [Marking messages as unread](/help/marking-messages-as-unread) -* [Configure unread message counters](/help/configure-unread-message-counters) -* [Configure where you land](/help/configure-where-you-land) -* [Emoji reactions](/help/emoji-reactions) -* [View your mentions](/help/view-your-mentions) -* [Star a message](/help/star-a-message) -* [Schedule a reminder](/help/schedule-a-reminder) -* [View images and videos](/help/view-images-and-videos) -* [View messages sent by a user](/help/view-messages-sent-by-a-user) -* [Link to a message or conversation](/help/link-to-a-message-or-conversation) -* [Searching for messages](/help/search-for-messages) -* [Printing messages](/help/printing-messages) -* [View message content as Markdown](/help/view-the-markdown-source-of-a-message) -* [View when message was sent](/help/view-the-exact-time-a-message-was-sent) -* [View a message's edit history](/help/view-a-messages-edit-history) -* [Collapse a message](/help/collapse-a-message) -* [Read receipts](/help/read-receipts) - -## People - -* [Introduction to users](/help/introduction-to-users) -* [User list](/help/user-list) -* [Status and availability](/help/status-and-availability) -* [User cards](/help/user-cards) -* [View someone's profile](/help/view-someones-profile) -* [Direct messages](/help/direct-messages) -* [Find administrators](/help/find-administrators) - -## Groups - -* [User groups](/help/user-groups) -* [View group members](/help/view-group-members) - -## Channels - -* [Introduction to channels](/help/introduction-to-channels) -* [Subscribe to a channel](/help/introduction-to-channels#browse-and-subscribe-to-channels) -* [Create a channel](/help/create-a-channel) -* [Pin a channel](/help/pin-a-channel) -* [Change the color of a channel](/help/change-the-color-of-a-channel) -* [Channel folders](/help/channel-folders) -* [Unsubscribe from a channel](/help/unsubscribe-from-a-channel) -* [Hide or reveal inactive channels](/help/manage-inactive-channels) -* [Move content to another channel](/help/move-content-to-another-channel) -* [View channel information](/help/view-channel-information) -* [View channel subscribers](/help/view-channel-subscribers) - -## Topics - -* [Introduction to topics](/help/introduction-to-topics) -* [Rename a topic](/help/rename-a-topic) -* [Resolve a topic](/help/resolve-a-topic) -* [Move content to another topic](/help/move-content-to-another-topic) -* [“General chat” topic](/help/general-chat-topic) -* [Delete a topic](/help/delete-a-topic) - -## Notifications - -* [Channel notifications](/help/channel-notifications) -* [Topic notifications](/help/topic-notifications) -* [Follow a topic](/help/follow-a-topic) -* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications) -* [Mute or unmute a channel](/help/mute-a-channel) -* [Mute or unmute a topic](/help/mute-a-topic) -* [Mute a user](/help/mute-a-user) -* [Email notifications](/help/email-notifications) -* [Desktop notifications](/help/desktop-notifications) -* [Mobile notifications](/help/mobile-notifications) -* [Do not disturb](/help/do-not-disturb) - -## Apps - -* [Download apps for every platform](https://zulip.com/apps/) -* [Mobile app installation guides](/help/mobile-app-install-guide) -* [Desktop installation guides](/help/desktop-app-install-guide) -* [Supported browsers](/help/supported-browsers) -* [Configure how links open](/help/configure-how-links-open) -* [Connect through a proxy](/help/connect-through-a-proxy) -* [Use a custom certificate](/help/custom-certificates) - -# Zulip administration - -## Organization profile - -* [Organization type](/help/organization-type) -* [Communities directory](/help/communities-directory) -* [Linking to your organization](/help/linking-to-zulip) -* [Change organization URL](/help/change-organization-url) -* [Deactivate your organization](/help/deactivate-your-organization) - -## Import an organization - -* [Import from Mattermost](/help/import-from-mattermost) -* [Import from Slack](/help/import-from-slack) -* [Import from Rocket.Chat](/help/import-from-rocketchat) -* [Export your organization](/help/export-your-organization) - -## Account creation and authentication - -* [Configure default new user settings](/help/configure-default-new-user-settings) -* [Custom profile fields](/help/custom-profile-fields) -* [Invite new users](/help/invite-new-users) -* [Restrict account creation](/help/restrict-account-creation) -* [Configure authentication methods](/help/configure-authentication-methods) -* [SAML authentication](/help/saml-authentication) -* [SCIM provisioning](/help/scim) - -## User management - -* [Manage a user](/help/manage-a-user) -* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) -* [Change a user's name](/help/change-a-users-name) -* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) -* [Manage a user's group membership](/help/manage-user-group-membership) - -## Channel management - -* [Create a channel](/help/create-a-channel) -* [Private channels](/help/channel-permissions#private-channels) -* [Public channels](/help/channel-permissions#public-channels) -* [Public access option](/help/public-access-option) -* [“General chat” channels](/help/general-chat-channels) -* [Manage channel folders](/help/manage-channel-folders) -* [Channel permissions](/help/channel-permissions) -* [Channel posting policy](/help/channel-posting-policy) -* [Configure who can administer a channel](/help/configure-who-can-administer-a-channel) -* [Restrict channel creation](/help/configure-who-can-create-channels) -* [Configure who can subscribe](/help/configure-who-can-subscribe) -* [Configure who can subscribe others](/help/configure-who-can-invite-to-channels) -* [Configure who can unsubscribe anyone](/help/configure-who-can-unsubscribe-others) -* [Subscribe users to a channel](/help/subscribe-users-to-a-channel) -* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel) -* [Set default channels for new users](/help/set-default-channels-for-new-users) -* [Rename a channel](/help/rename-a-channel) -* [Change a channel's description](/help/change-the-channel-description) -* [Pin information](/help/pin-information) -* [Change the privacy of a channel](/help/change-the-privacy-of-a-channel) -* [Delete or archive a channel](/help/archive-a-channel) - -## Permissions management - -* [Manage permissions](/help/manage-permissions) -* [Manage user groups](/help/manage-user-groups) -* [Deactivate a user group](/help/deactivate-a-user-group) -* [User roles](/help/user-roles) -* [Guest users](/help/guest-users) -* [Restrict direct messages](/help/restrict-direct-messages) -* [Restrict wildcard mentions](/help/restrict-wildcard-mentions) -* [Restrict message editing](/help/restrict-message-editing-and-deletion) -* [Restrict message edit history access](/help/restrict-message-edit-history-access) -* [Restrict moving messages](/help/restrict-moving-messages) -* [Restrict resolving topics](/help/restrict-resolving-topics) -* [Restrict name and email changes](/help/restrict-name-and-email-changes) -* [Restrict profile picture changes](/help/restrict-profile-picture-changes) -* [Restrict permissions of new members](/help/restrict-permissions-of-new-members) - -## Organization settings - -* [Configure organization language](/help/configure-organization-language) -* [Custom emoji](/help/custom-emoji) -* [Configure call provider](/help/configure-call-provider) -* [Add a custom linkifier](/help/add-a-custom-linkifier) -* [Require topics in channel messages](/help/require-topics) -* [Image, video and website previews](/help/image-video-and-website-previews) -* [Hide message content in emails](/help/hide-message-content-in-emails) -* [Message retention policy](/help/message-retention-policy) -* [Weekly digest emails](/help/digest-emails) -* [Disable welcome emails](/help/disable-welcome-emails) -* [Configure a custom welcome message](/help/configure-a-custom-welcome-message) -* [Configure automated notices](/help/configure-automated-notices) -* [Configure multi-language search](/help/configure-multi-language-search) -* [Usage statistics](/help/analytics) - -## Bots & integrations - -* [Bots overview](/help/bots-overview) -* [Integrations overview](/help/integrations-overview) -* [Add a bot or integration](/help/add-a-bot-or-integration) -* [Generate integration URL](/help/generate-integration-url) -* [Manage a bot](/help/manage-a-bot) -* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) -* [Request an integration](/help/request-an-integration) -* [Restrict bot creation](/help/restrict-bot-creation) -* [View your bots](/help/view-your-bots) -* [View all bots in your organization](/help/view-all-bots-in-your-organization) - -## Support - -* [View Zulip version](/help/view-zulip-version) -* [Zulip Cloud billing](/help/zulip-cloud-billing) -* [Self-hosted billing](/help/self-hosted-billing) -* [GDPR compliance](/help/gdpr-compliance) -* [Move to Zulip Cloud](/help/move-to-zulip-cloud) -* [Support the Zulip project](/help/support-zulip-project) -* [Linking to the Zulip website](/help/linking-to-zulip-website) -* [Contact support](/help/contact-support) +We work hard to make Zulip's help center comprehensive and easy to follow. +Please drop by the +[#documentation](https://chat.zulip.org/#narrow/channel/19-documentation) +channel in the [Zulip development +community](https://zulip.com/development-community/) to share ideas for how to +make it better.