Skip to content

Update the format section of the style guide to include HTTP response code section #7055

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Update the format section of the style guide to include HTTP response code section #7055

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25abd14
Update styleguide.md
forstisabella Sep 19, 2024
ec9ad4b
Update styleguide.md
forstisabella Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions styleguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Sub-bullets/sub-lists | If there are mutliple tasks within a step, break it up i
FAQs | Use H4s for FAQs. Don't use the liquid formatting. <b><br>When naming the FAQ section, use `FAQ` instead of `Frequently Asked Questions`.
External links | When inserting links that aren't on the segment.com/docs subdomain, follow this format: `[link text](https://google.com){:target="_blank"}` <br>Make sure the `{:target="_blank"}` is included after the link. This ensures that the link to the external site opens up in a new tab to avoid taking users away from the docs site.
Code blocks | When giving a code example that is more than a line long, use a code block. (For keyboard shortcuts, variables, and commands, use the single-backtick `code format`). Always use triple-backtick code fences to create a code block. Do not use the three-indent (three tabs/six spaces) mode, as this can conflict with nested list rendering.
HTTP error codes | When including an HTTP error code, write the entire code (for example, 400 Bad Request) and format the error code using single-backtick `code format`.


## Segment Specific Terms
Expand Down