Back to Zulip

Change a channel's description

starlight_help/src/content/docs/change-the-channel-description.mdx

12.02.4 KB
Original Source

import {TabItem, Tabs} from "@astrojs/starlight/components";

import FlattenedSteps from "../../components/FlattenedSteps.astro"; import NavigationSteps from "../../components/NavigationSteps.astro"; import ChannelSettingsNavbarTip from "../include/_ChannelSettingsNavbarTip.mdx"; import SaveChanges from "../include/_SaveChanges.mdx"; import SelectChannelViewGeneral from "../include/_SelectChannelViewGeneral.mdx";

import EditIcon from "~icons/zulip-icon/edit";

Channel descriptions can be used to explain the purpose of a channel, and link to usage guidelines, resources, or related channels. They appear in the navigation bar at the top of the web and desktop apps when you view the channel. You can hover over long channel descriptions with the mouse to view them in full.

Channel descriptions support Zulip's standard Markdown formatting, with the exception that image previews are disabled. Use Markdown formatting to include a link to a website, Zulip message, or topic in the channel description: [link text](URL).

<Tabs> <TabItem label="Desktop/Web"> <FlattenedSteps> <NavigationSteps target="relative/channel/all" />
  1. Select a channel.

  <SelectChannelViewGeneral />

  1. Click the **edit channel name and description**
     (<EditIcon />) icon to the right of the
     channel name, and enter a new description.

  <SaveChanges />
</FlattenedSteps>

<ChannelSettingsNavbarTip />
</TabItem> <TabItem label="Mobile"> Access this feature by following the web app instructions in your mobile device browser.
Implementation of this feature in the mobile app is tracked [on
GitHub](https://github.com/zulip/zulip-flutter/issues/1102). If
you're interested in this feature, please react to the issue's
description with 👍.
</TabItem> </Tabs>