diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 804bed99e3..f9c6078d4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribution guide -This guide covers how to contribute to the Ably docs repository. From general pull request processes, to how to update and use each textile component. +This guide covers how to contribute to the Ably docs repository, including general pull request processes and content formatting. ## Pull request process @@ -35,12 +35,12 @@ There are two main locations that contributors need to work with to varying exte | Folder | Contains | | ------ | -------- | -| content | All content pages written in textile. | -| src | Images, navigation and language version and management. | +| how-tos | Tutorial content in MDX format. | +| src | Images, navigation, and language version management. | -## Textile format +## Content format -The following sections discuss how to write and implement each component using textile. +Documentation pages use MDX format for content. The following sections discuss common formatting patterns. ### Metadata @@ -73,19 +73,17 @@ An example heading (with a custom anchor link) is: `h2(#subscribe). Subscribe to ### Links -Links in textile are written in quotation marks. Link text can also be [code styled](#in-line-code). +Use standard Markdown link syntax: `[link text](url)`. #### Internal links -To link to another heading on the same page use the anchor link: `"channel state changes":#listen-for-state`. +To link to another docs page use: `[messages](/docs/channels/message)`. -To link to another docs page use: `"messages":/docs/channels/message`. - -You may also use in-line code to style link text: `"@get()@":/docs/api/realtime-sdk/channels#get method` +To link to a heading on the same page: `[channel state changes](#listen-for-state)`. #### External links -To link externally, or outside of the docs repository, use a fully qualified link: `"Ably dashboard":https://ably.com/dashboard`. +Use fully qualified URLs: `[Ably dashboard](https://ably.com/dashboard)`. > Note: for dashboard links you can use `/any/` as the account ID to link directly to a specific page. For example: `https://ably.com/accounts/any/edit` for the account settings page. @@ -164,7 +162,7 @@ To make a cell span two columns: ### Admonitions -There are three types of admonition that can be used; `note`, `important` and `further-reading`. Update the value of `data-type` to switch between them. Admonitions are written using the HTML `