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
Updated/removed some vale styles, removed "client:load" from some component pages.
Did a quick review of all pages and made other updates as necessary, depending on what Vale yelled about and other things I found.
Copy file name to clipboardExpand all lines: src/content/docs/classes/details.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The `<details>` disclosure element is an HTML element that creates a disclosure
8
8
We also have an in-house [Disclosure component](/shared/disclosure), but we decided in October 2024 to move away from using it. We may deprecate the component completely in the future.
9
9
:::
10
10
11
-
You can nest any other Markdown syntax inside a `<details>` element. Some, if not all, of Starlight's components can also be nested. For example, you can use an aside within the element.
11
+
You can nest any other Markdown syntax inside a `<details>` element. Some, if not all, of Starlight's components can also be nested. For example, you can use an aside in the element.
This guide is designed for writers and contributors involved in documenting our APIs, which use both GraphQL and REST API technologies.
11
11
12
-
At Interledger, we maintain multiple repositories that encompass a variety of projects, each serving different purposes within our ecosystem. This style guide aims to provide a cohesive framework for documenting these APIs so that our docs are clear, consistent, and aligned with our standards.
12
+
At Interledger, we maintain multiple repositories that encompass a variety of projects, each serving different purposes in our ecosystem. This style guide aims to provide a cohesive framework for documenting these APIs so that our docs are clear, consistent, and aligned with our standards.
13
13
14
14
## GraphQL
15
15
@@ -23,7 +23,7 @@ For more in-depth information about GraphQL, take a look at the following resour
23
23
24
24
### Documenting GraphQL examples
25
25
26
-
We've created a standardized format to maintain a consistent look and feel when documenting example GraphQL queries and mutations. Each GraphQL example should be organized into three tabs: **Operation**, **Variables**, and **Response**.
26
+
We've created a standardized format to maintain a consistent look and feel when documenting example GraphQL queries and mutations. Organize each GraphQL example into three tabs: **Operation**, **Variables**, and **Response**.
27
27
28
28
To create these multi-tabbed GraphQL examples, we're using the built-in Starlight [`<Tabs>` and `<TabItem>`](https://starlight.astro.build/components/tabs/) components. Each of the examples below will show the `<TabItem>` tags. The full example will be wrapped in the `<Tabs>` tag.
29
29
@@ -38,7 +38,7 @@ Make sure you import the `<Tabs>` and `<TabItem>` components to your MDX file li
38
38
39
39
- Include the query/mutation in a code block
40
40
- Specify `graphql` as the language for syntax highlighting
41
-
-Do not include the query/mutation name in the header
This guide is in progress and won’t be complete until we start digging into the other doc sites.
9
-
:::
10
-
11
-
This guide covers styles that are shared between all doc sites using the Starlight framework.
12
-
13
-
Styles should apply to all sites whenever possible; however, there could be a need for site-specific styles. If you can’t find what you’re looking for in this guide, check in a site-specific guide.
There are certain styles that we should consistently follow regardless of the doc site we are working on. If you can't find information about a style here, check the site-specific guides linked in the sidenav.
20
8
21
9
## Rule #1
22
10
23
11
Break the rules.
24
12
25
-
Ok, try not to, but the audience’s best interest should always come first. Deviations are OK if they help enhance the clarity of the doc.
13
+
Ok, try not to, but the audience's best interest should always come first. Deviations are OK if they help enhance the clarity of the doc.
26
14
27
15
## Account servicing entity
28
16
@@ -40,7 +28,7 @@ For buttons with labels/text strings, bold the text that appears in the button.
40
28
- Click **Revoke public & private key**. ✅
41
29
- Click on Revoke public & private key. ❌
42
30
43
-
For buttons that are icons (e.g., arrows), describe what should be clicked and don't use bold. Avoid using the word _on_ unless it helps with clarity. For example:
31
+
For buttons that are icons (for example, arrows), describe what should be clicked and don't use bold. Avoid using the word _on_ unless it helps with clarity. For example:
44
32
45
33
- Click the arrow to proceed. ✅
46
34
- Click on the **arrow** to proceed. ❌
@@ -65,20 +53,20 @@ Add a comma before the conjunction in a list of three or more items. This is kno
65
53
66
54
## Content reuse
67
55
68
-
Consider using MDX transclusion, also called MDX partials, if you’re using the same content across multiple page in the same doc project. Transclusion lets you embed MDX documents in other documents. We’ll refer to these embedded documents as partials.
56
+
Consider using MDX transclusion, also called MDX partials, if you're using the same content across multiple page in the same doc project. Transclusion lets you embed MDX documents in other documents. We’ll refer to these embedded documents as partials.
69
57
70
58
### /src/partials
71
59
72
-
Place MDX files to embed within the `/src/partials` folder. Create the folder if it doesn’t exist.
60
+
Place MDX partial files in the `/src/partials` folder. Create the folder if it doesn't exist.
73
61
74
62
### Partial files
75
63
76
-
Typically, partials should be used for small chunks of repeating content. If the partial file contains more than a paragraph, there may be a better way to present the information within the doc project.
64
+
Typically, partials should be used for small chunks of repeating content. If the partial file contains more than a paragraph, there may be a better way to present the information in the doc project.
77
65
78
66
Note:
79
67
80
-
- Don’t include frontmatter in your partials file (e.g., `title`).
81
-
- Headings within a partials file do not appear in a page’s table of contents.
68
+
- Don't include frontmatter in your partials file (for example, `title`).
69
+
- Headings in a partials file **will not** appear in a page’s table of contents.
82
70
- Multiple partial files are supported within a single page.
83
71
84
72
### Embed a partial
@@ -89,9 +77,9 @@ First, import the partial file into the page:
89
77
importNoPayfrom"/src/partials/glitchNoPay.mdx";
90
78
```
91
79
92
-
Name the partial however you’d like, but without spaces. In the example above, the partial's name is `NoPay`.
80
+
Name the partial however you’d like, but without spaces. In the preceding example, the partial's name is `NoPay`.
93
81
94
-
Using the name you defined, add the partial within the page's content, in the location it should appear:
82
+
Using the name you defined, add the partial in the page's content, in the location it should appear:
95
83
96
84
```mdx
97
85
This is a paragraph of text. I want the partial content to appear beneath this paragraph.
- Spell out the entire phrase on first use within a page, then include initialism in parentheses.
131
+
- Spell out the entire phrase on first use in a page, then include initialism in parentheses.
144
132
- In long pages, periodically spell out the entire phrase and include the initialism in parentheses. Long is subjective, use your best judgment.
145
133
- If you use an initialism for a term that also appears in the glossary, add the initialism to the glossary term.
146
-
- Don’t use initialisms for a term that only appears a few times within a page. Few is subjective, use your best judgment.
134
+
- Don't use initialisms for a term that only appears a few times in a page. Few is subjective, use your best judgment.
147
135
148
136
## Lists
149
137
150
138
- Lists should typically contain a minimum of three items.
151
139
- Use unordered lists (bullets) when item order is unimportant.
152
-
- Use ordered (numbered) lists when order is important (e.g., item #1 must be completed before item #2).
153
-
- Keep each list as parallel as possible. This list is not a good example.
140
+
- Use ordered (numbered) lists when order is important (for example, item #1 must be completed before item #2).
141
+
- Keep each list as parallel as possible. This list isn't a good example.
154
142
- All items start with a noun, or all start with a verb.
155
143
- All items have ending punctuation, or none do.
156
144
- All items start with a capital letter, or all start with lowercase.
157
145
- If a list is introduced by a full sentence, end the sentence with the proper punctuation. If introduced with a sentence fragment, end with a colon.
158
146
159
147
## Please
160
148
161
-
We're taking [Google's approach](https://developers.google.com/style/word-list#please): Don’t use please in the normal course of explaining how to use a product, even if you’re explaining a difficult task.
149
+
We're taking [Google's approach](https://developers.google.com/style/word-list#please): Don't use "please" in the normal course of explaining how to use a product, even if you're explaining a difficult task.
162
150
163
151
## See
164
152
165
-
Previously, we tried to be more inclusive by staying away from using *see* when referring to a link (e.g., *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*).
166
154
167
155
We've decided that it **is** OK to use *see*.
168
156
169
-
The W3C uses *see* for link references within their [Accessibility, Usability, and Inclusion](https://www.w3.org/WAI/fundamentals/accessibility-usability-inclusion/) page. Similarly, Google uses it within 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.
170
158
171
159
## SHA (secure hash algorithm)
172
160
173
-
SHA is a common technical term that does not 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.
174
162
175
163
When an a/an article is needed, use **a**.
176
164
@@ -179,9 +167,9 @@ When an a/an article is needed, use **a**.
179
167
180
168
## Sidebar categories
181
169
182
-
Starlight does not allow a sidebar category, or book, to also be a page. For example, clicking **Shared Component** in this project's sidebar expands/collapses the category without navigating you to a new page.
170
+
Starlight doesn't allow a sidebar category, or book, to also be a page. For example, clicking **Shared Component** in this project's sidebar expands/collapses the category without navigating you to a new page.
183
171
184
-
Since a category cannot be a page, ensure the category's name and pages within the category are titled somewhat differently.
172
+
Since a category can't be a page, ensure the category's name and the pages in the category are titled somewhat differently.
185
173
186
174
For example:
187
175
@@ -193,7 +181,7 @@ For example:
193
181
194
182
## Sidebar external links
195
183
196
-
If an external link is required in the sidebar, you can make use of Astro's [sidebar `attrs` property](https://starlight.astro.build/guides/sidebar/#custom-html-attributes) to open the link in a new tab and also add an indicator icon to show the link is external.
184
+
If an external link is required in the sidebar, you can use Astro's [sidebar `attrs` property](https://starlight.astro.build/guides/sidebar/#custom-html-attributes) to open the link in a new tab and also add an indicator icon to show the link is external.
197
185
198
186
```js
199
187
sidebar: [
@@ -215,7 +203,7 @@ Always spell out test network. Don't abbreviate to testnet.
215
203
216
204
## Tooltips
217
205
218
-
The [Tooltip](/shared/tooltip) component allows you to add additional text to a word or phrase. The text appears when you hover your cursor over the <Tooltipcontent='This is an example tooltip'client:load><span>question mark</span></Tooltip>.
206
+
The [Tooltip](/shared/tooltip) component allows you to add additional text to a word or phrase. The text appears when you hover your cursor over the <Tooltipcontent='This is an example tooltip'><span>question mark</span></Tooltip>.
219
207
220
208
- Tooltips should be short. Consider linking to a page or glossary term instead of using the Tooltip component if a tooltip becomes too long.
221
209
- Longer tooltips that appear at the top of the page might be cut off by the UI.
The majority of content within the documentation projects are written in Markdown. This page touches on some high-level Markdown topics. For more information on Markdown syntax, see:
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:
@@ -18,22 +18,24 @@ Frontmatter [YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) is
18
18
19
19
Escape a character by adding a backslash before the character.
20
20
21
-
For example, to show \{client_domain/jwks.json\} in plain text, without Starlight giving you an error, you'd need to format it like this:
21
+
For example, to show \{client_domain/jwks.json\} in plain text (as shown here), without Starlight giving you an error, you'd need to format it like this:
22
22
23
-
`\{client_domain/jwks.json\}`
23
+
`\{client_domain/jwks.json}`
24
24
25
25
## Frontmatter
26
26
27
-
A `title` is required frontmatter for most files. One scenario in which a title is **not** required is when the file is a [partial](/content/global#content-reuse).
28
-
29
-
Check the full list of [frontmatter configuration](https://starlight.astro.build/reference/frontmatter/) for more fun options.
27
+
Most files require a `title` in their frontmatter.
30
28
31
29
```md
32
30
---
33
31
title: Remember to set this
34
32
---
35
33
```
36
34
35
+
One scenario in which a title is **not** required is when the file is a [partial](/content/global#content-reuse).
36
+
37
+
Check the full list of [frontmatter configuration](https://starlight.astro.build/reference/frontmatter/) for more fun options.
38
+
37
39
## Images
38
40
39
41
Images in Starlight use [Astro’s built-in optimized asset support](https://docs.astro.build/en/guides/assets/).
@@ -50,7 +52,7 @@ You may want to further organise the `img` folder with subfolders if the project
50
52
51
53
## Headings
52
54
53
-
Starlight is configured to automatically use your page title as a top-level heading and will include an "Overview" heading at top of each page's table of contents. Starlight does not provide a native way hide "Overview" or change the wording.
55
+
Starlight automatically uses your page title as a top-level heading and includes an "Overview" heading at top of each page's table of contents. Starlight doesn't provide a native way hide "Overview" or change the wording. However, we do have the [RemoveOverview](/shared/removeoverview) component.
54
56
55
57
### Automatic heading anchor links
56
58
@@ -60,18 +62,16 @@ Level 2 (`<h2>`) and Level 3 (`<h3>`) headings automatically appear in a page's
60
62
61
63
## Advanced Markdown and MDX configuration
62
64
63
-
Starlight uses Astro’s Markdown and MDX renderer built on remark and rehype. You can add support for custom syntax and behavior by adding `remarkPlugins` or `rehypePlugins` in your Astro config file. See [“Configuring Markdown and MDX”](https://docs.astro.build/en/guides/markdown-content/#configuring-markdown-and-mdx) in the Astro docs to learn more.
65
+
Starlight uses Astro's Markdown and MDX renderer built on remark and rehype. You can add support for custom syntax and behavior by adding `remarkPlugins` or `rehypePlugins` in your Astro config file. See [“Configuring Markdown and MDX”](https://docs.astro.build/en/guides/markdown-content/#configuring-markdown-and-mdx) in the Astro docs to learn more.
64
66
65
67
### Mermaid diagrams
66
68
67
-
:::danger
68
-
We no longer support mermaid diagrams using the markdown syntax. Instead, use our custom [`Mermaid` component](/shared/mermaid).
69
-
:::
69
+
Use our custom [`Mermaid` component](/shared/mermaid) to add Mermaid diagrams to the docs.
70
70
71
71
### Mathjax
72
72
73
73
:::caution
74
-
This component requires an extra dependency on [remark-math](https://github.com/remarkjs/remark-math/tree/main) and [rehype-mathjax](https://github.com/remarkjs/remark-math/tree/main/packages/rehype-mathjax) and thus is not enabled by default on all projects. Ping the person responsible for documentation architecture if your project doesn't render mathjax properly.
74
+
This component requires an extra dependency on [remark-math](https://github.com/remarkjs/remark-math/tree/main) and [rehype-mathjax](https://github.com/remarkjs/remark-math/tree/main/packages/rehype-mathjax) and thus isn't enabled by default on all projects. Ping the person responsible for documentation architecture if your project doesn't render mathjax properly.
0 commit comments