You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: styleguide.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Rule | Description |
32
32
---- | ----------- |
33
33
Field names in any app | **Bold** the use of field names.
34
34
Hyperlinks | Link to the noun or topic of the article rather than `here`.
35
-
Numbers | Use digits/numerals in all cases, except at the beginning of a sentnce. <br><br> For example, instead of `There are five options to choose from.`→ use `There are 5 options to choose from.`
35
+
Numbers | Use digits/numerals in all cases, except at the beginning of a sentence. <br><br> For example, instead of `There are five options to choose from.`→ use `There are 5 options to choose from.`
36
36
Entered text in the app | Use `code format`
37
37
Capitalization | Capitalize Segment and Segment product names. For example, "privacy" by itself isn't capitalized, but "Segment Privacy Portal" is. Page titles and other UI text should be in lower case. <br><br>Capitalize the words "Sources", "Destinations", and "Warehouses" when referring them as product names (for example: “You can use Sources to…”) but decap them when referring to them generically (“You can connect your warehouse to…”)
38
38
`we` and `they` | Avoid using `we` and `they`. Be explicit about naming who is being referenced. Because Segment has such a large footprint of documentation around third-party integrations, it's important to be very clear about who "we" are in any given part of the doc. Instead of using "we", your should refer to our software or processes in the third person: "Segment creates..." "Segment sends..."
@@ -49,6 +49,7 @@ Libraries vs SDKs | Segment Source libraries are libraries, not SDKs. The bundle
49
49
Styling Segment Methods | When you refer to a method *outside* of code, use: <li>Page call, Identify call <br><br>Avoid styling like inline code: <li> Page() method <br><li> `page()` <br><li> `.identify()` <br><li> `Identify` call
50
50
Styling Segment Events | When you refer to an event *outside* of code, format it like inline code. For example: `Product Viewed` or `Clicked Login Button`.
51
51
Connection modes | Device-mode and Cloud-mode are always hyphenated. They should be capitalized when referring to the mode in abstract (as a product name), but can be decapped when used in running text about a specific destination. <br><br>We’ve had a lot of confusion in the past due to using device-mode and client-side, and cloud-mode and server-side interchangeably when referring to our Connection Modes. There are legitimate uses of both the terms client-side and server-side when referring to things _other than_ our connection modes, so we’re moving to use **Device-mode** and **Cloud-mode** instead.
52
+
Sources and destinations | When you refer broadly to sources or destinations, don't capitalize source/destination. For example, "_A source is a website, server library, mobile SDK, or cloud application..._" <br><br>If you're referring to the full name of a source or destination, like Slack (Actions) Destination or Facebook Ads Source, for example, capitalize source/destination.
52
53
53
54
54
55
## Images
@@ -65,7 +66,7 @@ We have some fairly complex CSS, and lists with lots of "stuff" in them. Normall
65
66
66
67
On top of this, some of the Premonition callouts we use, for some reason, break list ordering. So you can't add an "info" box inside a running list. (Boooo.)
67
68
68
-
To get around this, you can let the previous list item end whereever if needs to, then create an entire new ordered list with specific HTML to allow you to override the start number.
69
+
To get around this, you can let the previous list item end wherever if needs to, then create an entire new ordered list with specific HTML to allow you to override the start number.
0 commit comments