Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

contributor docs: Extend help center writing style documentation. #29906

Merged
merged 1 commit into from
May 2, 2024

Conversation

alya
Copy link
Contributor

@alya alya commented Apr 30, 2024

@alya alya added the integration review Added by maintainers when a PR may be ready for integration. label Apr 30, 2024
@alya
Copy link
Contributor Author

alya commented Apr 30, 2024

Trying to run a linter just hangs for me (I tried tools/lint --only prettier --fix docs/documentation/helpcenter.md to minimize what's being run), so I dunno how to fix this PR.

@timabbott timabbott merged commit a302278 into zulip:main May 2, 2024
4 of 5 checks passed
@timabbott
Copy link
Sponsor Member

Fixed the linter error and merged. For reference, the Prettier issue was:

diff --git a/docs/documentation/helpcenter.md b/docs/documentation/helpcenter.md
index c573f3acc1..ed42389122 100644
--- a/docs/documentation/helpcenter.md
+++ b/docs/documentation/helpcenter.md
@@ -220,7 +220,7 @@ is needed. In particular:
 - Do not list out the options the user is choosing from. Once the user finds the
   right menu in the UI, they'll be able to see the options. In some cases, we
   may describe the options in more detail outside of the instructions block.
-- Never identify or refer to a button by its color. You *can* describe its
+- Never identify or refer to a button by its color. You _can_ describe its
   location.
 - Use screenshots only when it's very difficult to get your point across without
   them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration review Added by maintainers when a PR may be ready for integration. size: S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants