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
@@ -33,7 +33,6 @@ Make sure you import the `<Tabs>` and `<TabItem>` components to your MDX file li
33
33
`import { Tabs, TabItem } from '@astrojs/starlight/components'`
34
34
:::
35
35
36
-
37
36
#### Operation tab
38
37
39
38
- Include the query/mutation in a code block
@@ -83,7 +82,7 @@ Make sure you import the `<Tabs>` and `<TabItem>` components to your MDX file li
83
82
</CodeBlock>
84
83
85
84
:::note
86
-
Before this style guide was created, there were older GraphQL examples that, in most cases, contained a table displaying variable names and descriptions. If you are updating one of these older examples, delete this table. The input object documentation explains all of the variables and we link to that page in the Variables tab.
85
+
Before this style guide was created, there were older GraphQL examples that, in most cases, contained a table displaying variable names and descriptions. If you are updating one of these older examples, delete this table. The input object documentation explains all of the variables and we link to that page in the Variables tab.
87
86
:::
88
87
89
88
#### Response tab
@@ -146,6 +145,7 @@ Before this style guide was created, there were older GraphQL examples that, in
146
145
}
147
146
}
148
147
```
148
+
149
149
</TabItem>
150
150
</Tabs>
151
151
````
@@ -186,9 +186,10 @@ Before this style guide was created, there were older GraphQL examples that, in
Previously, we tried to be more inclusive by staying away from using *see* when referring to a link (for example, *see XYZ for more information*).
153
+
Previously, we tried to be more inclusive by staying away from using _see_ when referring to a link (for example, _see XYZ for more information_).
154
154
155
-
We've decided that it **is** OK to use *see*.
155
+
We've decided that it **is** OK to use _see_.
156
156
157
-
The W3C uses *see* for link references in their [Accessibility, Usability, and Inclusion](https://www.w3.org/WAI/fundamentals/accessibility-usability-inclusion/) page. Similarly, Google uses it in their [Write inclusive documentation](https://developers.google.com/style/inclusive-documentation) page and their [word list](https://developers.google.com/style/word-list#see) indicates its OK to use when referring to links and cross-references.
157
+
The W3C uses _see_ for link references in their [Accessibility, Usability, and Inclusion](https://www.w3.org/WAI/fundamentals/accessibility-usability-inclusion/) page. Similarly, Google uses it in their [Write inclusive documentation](https://developers.google.com/style/inclusive-documentation) page and their [word list](https://developers.google.com/style/word-list#see) indicates its OK to use when referring to links and cross-references.
158
158
159
159
## SHA (secure hash algorithm)
160
160
161
-
SHA is a common technical term that doesn't need to be defined before it's first use.
161
+
SHA is a common technical term that doesn't need to be defined before it's first use.
162
162
163
-
When an a/an article is needed, use **a**.
163
+
When an a/an article is needed, use **a**.
164
164
165
165
- A SHA-256 hash of the interaction is sent in the response. ✅
166
166
- An SHA-256 has of the interaction is sent in the response. ❌
Copy file name to clipboardExpand all lines: src/content/docs/content/markdown.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ import { CodeBlock } from "@interledger/docs-design-system";
8
8
9
9
Most content in the documentation projects are written in Markdown. This page touches on some high-level Markdown topics. For more information on Markdown syntax, see:
1. Your PR title must contain the appropriate prefix (`docs:`).
9
+
1.Your PR title must contain the appropriate prefix (`docs:`).
10
10
11
-
2. Run the following command in the `/packages/documentation` directory:
11
+
2.Run the following command in the `/packages/documentation` directory:
12
12
13
-
```
14
-
npx prettier . --write
15
-
```
13
+
```
14
+
npx prettier . --write
15
+
```
16
16
17
-
You can also try the following. It might work, or you might get an error.
17
+
You can also try the following. It might work, or you might get an error.
18
18
19
-
```
20
-
pnpm format
21
-
```
22
-
</Card>
19
+
```
20
+
pnpm format
21
+
```
22
+
23
+
</Card>
23
24
24
25
<Cardtitle="After a Starlight upgrade to rafiki"icon="star">
25
26
```
@@ -57,17 +58,19 @@ Open the generated HTML files (`src/pages/apis/graphql/auth/index.html` and `src
57
58
```
58
59
59
60
This ensures that the GraphQL API docs are included in the site search.
61
+
60
62
</Card>
61
63
62
64
## Nouns
63
65
64
66
### Common nouns
65
-
* authorization server
66
-
* resource server
67
+
68
+
- authorization server
69
+
- resource server
67
70
68
71
## Spellings
69
72
70
-
### backend/frontend
73
+
### backend/frontend
71
74
72
75
When writing about the backend/frontend services and packages in Rafiki, spell as shown. Don't hyphenate or add a space (for example, back end). FWIW, this is how Microsoft, Google, and Cloudflare treat the terms in their docs.
73
76
@@ -77,8 +80,8 @@ When writing about the backend/frontend services and packages in Rafiki, spell a
77
80
78
81
Many of the tables in the Rafiki docs are wider than the main content panel. We've tried to care for this in a few ways.
79
82
80
-
* We implemented toggles across all doc sites that allows you to collapse/expand the left and right panels. This gives the main content panel a wider viewable area.
81
-
* We also added support to the Rafiki docs for custom CSS table styles.
83
+
- We implemented toggles across all doc sites that allows you to collapse/expand the left and right panels. This gives the main content panel a wider viewable area.
84
+
- We also added support to the Rafiki docs for custom CSS table styles.
82
85
83
86
You can wrap your markdown table in one of the following `div`s.
84
87
@@ -103,6 +106,7 @@ You can wrap your markdown table in one of the following `div`s.
0 commit comments