Skip to content

Commit 4c2c34b

Browse files
kennethkalmerclaude
andcommitted
Update documentation to reflect textile removal
Update references in documentation and style guide to remove mentions of textile format now that it is no longer supported. Changes: - Update CONTRIBUTING.md to remove textile references - Fix prettier formatting in src/pages/docs/404.js - Update writing-style-guide.md to remove textile mention 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 471396d commit 4c2c34b

File tree

3 files changed

+15
-28
lines changed

3 files changed

+15
-28
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribution guide
22

3-
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.
3+
This guide covers how to contribute to the Ably docs repository, including general pull request processes and content formatting.
44

55
## Pull request process
66

@@ -35,12 +35,12 @@ There are two main locations that contributors need to work with to varying exte
3535

3636
| Folder | Contains |
3737
| ------ | -------- |
38-
| content | All content pages written in textile. |
39-
| src | Images, navigation and language version and management. |
38+
| how-tos | Tutorial content in MDX format. |
39+
| src | Images, navigation, and language version management. |
4040

41-
## Textile format
41+
## Content format
4242

43-
The following sections discuss how to write and implement each component using textile.
43+
Documentation pages use MDX format for content. The following sections discuss common formatting patterns.
4444

4545
### Metadata
4646

@@ -73,19 +73,17 @@ An example heading (with a custom anchor link) is: `h2(#subscribe). Subscribe to
7373

7474
### Links
7575

76-
Links in textile are written in quotation marks. Link text can also be [code styled](#in-line-code).
76+
Use standard Markdown link syntax: `[link text](url)`.
7777

7878
#### Internal links
7979

80-
To link to another heading on the same page use the anchor link: `"channel state changes":#listen-for-state`.
80+
To link to another docs page use: `[messages](/docs/channels/message)`.
8181

82-
To link to another docs page use: `"messages":/docs/channels/message`.
83-
84-
You may also use in-line code to style link text: `"@get()@":/docs/api/realtime-sdk/channels#get method`
82+
To link to a heading on the same page: `[channel state changes](#listen-for-state)`.
8583

8684
#### External links
8785

88-
To link externally, or outside of the docs repository, use a fully qualified link: `"Ably dashboard":https://ably.com/dashboard`.
86+
Use fully qualified URLs: `[Ably dashboard](https://ably.com/dashboard)`.
8987

9088
> 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.
9189
@@ -164,7 +162,7 @@ To make a cell span two columns:
164162

165163
### Admonitions
166164

167-
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 `<aside>` tag. Content must be constructed in HTML, other than links and in-line code styling which accept textile format.
165+
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 `<aside>` tag with HTML or Markdown content.
168166

169167
```html
170168
<aside data-type='note'>
@@ -198,7 +196,7 @@ Textile accepts several formats for unordered lists, however `*` should be used
198196
* Mint Choc Chip
199197
```
200198

201-
For ordered lists, textile will accept any number before a `.` and order it appropriately. Ascending numbers should be used for readability and consistency.
199+
For ordered lists, use standard Markdown syntax with ascending numbers for readability and consistency.
202200

203201
```plaintext
204202
1. Cornetto
@@ -329,7 +327,7 @@ bq(definition).
329327
330328
### Partials
331329
332-
API references make use of [partials](content/partials/) where content is reused between files. They are included in .textile files using the following syntax:
330+
API references previously used partials for reusable content. This functionality has been replaced with component-based content reuse.
333331
334332
```plaintext
335333
<%= partial partial_version('realtime/_stats') %>

src/pages/docs/404.js

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,8 @@ const NotFoundPage = () => {
1111
<br />
1212
{process.env.NODE_ENV === 'development' ? (
1313
<>
14-
Try creating a new page in:
15-
<ul>
16-
<li>
17-
<code>src/pages/</code>: for specific pages
18-
</li>
19-
<li>
20-
<code>data/textile/nanoc-compatible</code>: for complete textile pages
21-
</li>
22-
<li>
23-
<code>data/textile/partials</code>: for reusable textile sections &endash; ask if there&apos;s a
24-
preferred alternative first.
25-
</li>
26-
</ul>
14+
Try creating a new page in <code>src/pages/</code> for specific pages, or using MDX in <code>how-tos/</code>
15+
.
2716
</>
2817
) : null}
2918
<br />

writing-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
These are technical writing guidelines that should be used for Ably's developer documentation.
44

5-
This guide does not cover the details of marking up content source. See the [documentation formatting guide](https://github.com/ably/docs/blob/main/content/client-lib-development-guide/documentation-formatting-guide.textile) for the latest details on how to markup source content.
5+
This guide does not cover the details of marking up content source. See the [CONTRIBUTING.md](CONTRIBUTING.md) guide for details on content formatting.
66

77
Some of the benefits of using this style guide are:
88

0 commit comments

Comments
 (0)