Commit Graph

13 Commits

Author SHA1 Message Date
Lauryn Menard fe7d7b48db help-docs: Use `<kbd>` HTML elements for references to keyboard keys.
Updates references to keyboard keys in the help center docs to use
`<kbd>` HTML elements, which also means updating them to be as the
key would appear on a keyboard.

Previously, uppercase and lowercase letters were used to indicate
when/if the `Shift` key was being used, and even that was not
consistent throughout the documentation.

For CSS styling, adds a similar rule for `<kbd>` elements that is
used in `/static/styles/app_components.css`. And updates the CSS
class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts`
accordingly.

Also, takes advantage of revising these pages for making small
updates for current help center documentation practices.
2022-09-13 11:16:14 -07:00
David Rosa a5eea68cf5 help-docs: Fix cross-links to help center pages about linking to Zulip.
Renames the main heading of "Linking to your organization" to match up
with the sidebar index title and adds a "Related articles" section.

Fixes cross-link title in "Link to a message or conversation".

Fixes: #22590.
2022-07-27 13:44:59 -07:00
David Rosa 2e2cd3eb49 help-docs: Document "Copy link to stream" mobile app feature.
Adds a new tab with instructions for mobile app users.

Adds new macros with instructions for accessing the long-press menu.

Fixes: #22197.
2022-06-30 11:24:22 -07:00
David Rosa 3474567521 help-docs: Document "Copy link to topic" mobile app feature.
Adds a "Mobile" tab with straightforward instructions for accessing
the long-press menu using two new macros.

Knowing where to access the long-press menu is intuitive, except when
the user is in a topic narrow. It's not immediately obvious that the
top bar can be long-pressed so this adds a "Tip block" using a new macro
to clarify things in this scenario.

Also, this combines the instructions for Desktop and Web into a single
tab because the numbered steps work on both platforms. So this documents
the alternate method via the browser's address bar as a "Tip block" to
avoid stacking alternative numbered steps into a single tab.
This updates the stream and message link instructions too.

Fixes: #22147.
2022-06-08 12:24:09 -07:00
David Rosa 52ef574d3e help-docs: Fix minor errors in "Link to a message or conversation".
Removes the ":" which have accidentally ended up in the "Get a link
to a specific topic" and "Get a link to a specific stream" headings.

Renames the "Via browser's address bar" tab to "Web" so that it
stays consistent with other help center articles.

Fixes part of #22147.
2022-06-08 12:20:32 -07:00
Lauryn Menard b67288db67 help_docs: Extend options for getting links to Zulip content.
Extends the linking to Zulip documentation to cover:

- Getting URLs to messages via the message timestamp.
- Getting links to topics via the three-dots menu.
- Getting links to streams via right-click context menu.

Creates a new tabbed section for using the browser
address bar to copy URLs.
2022-03-22 12:38:09 -07:00
Tim Abbott 8f698227f2 help: Fix alternatively typo.
This should have been in the previous commit.
2022-02-22 10:19:12 -08:00
Lauryn Menard ae8ab1d831 help_center: Add Markdown auto-link details link doc page.
Adds a section about the Markdown feature to auto-link to
existing streams and topics in a Zulip message.

Also, does a little reformatting of existing text/tabs and
adds a related links section to the page.

Fixes #21085.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-02-22 10:14:19 -08:00
Anders Kaseorg 5360bd76ac help: Add newline after admonition header for Prettier compatibility.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-10 10:39:25 -07:00
Tim Abbott f745efdde0 help: Link quote-and-reply and permalink articles.
This to a partial rewrite of the quote-and-reply article to explain
the current details for how it works (the permanent link is relatively
new).
2021-04-03 07:51:29 -07:00
Tim Abbott c01c947f5b help: Clean up documentation around permanent links. 2021-04-03 07:51:10 -07:00
Rishi Gupta 998d0b70ed help: Update Reading Messages section to conform to style guide. 2019-03-21 12:56:38 -07:00
Rishi Gupta cd57a8ede4 user docs: Update share-a-message-or-conversation. 2018-09-16 10:13:43 -07:00