Skip to content

Commit fb2af56

Browse files
docs: housekeeping (#96)
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.
1 parent 557afc7 commit fb2af56

File tree

20 files changed

+157
-382
lines changed

20 files changed

+157
-382
lines changed
75 KB
Loading
249 KB
Loading
168 KB
Loading

src/content/docs/classes/details.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `<details>` disclosure element is an HTML element that creates a disclosure
88
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.
99
:::
1010

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.
1212

1313
## Example usage
1414

src/content/docs/content/api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'
99

1010
This guide is designed for writers and contributors involved in documenting our APIs, which use both GraphQL and REST API technologies.
1111

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.
1313

1414
## GraphQL
1515

@@ -23,7 +23,7 @@ For more in-depth information about GraphQL, take a look at the following resour
2323

2424
### Documenting GraphQL examples
2525

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**.
2727

2828
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.
2929

@@ -38,7 +38,7 @@ Make sure you import the `<Tabs>` and `<TabItem>` components to your MDX file li
3838

3939
- Include the query/mutation in a code block
4040
- Specify `graphql` as the language for syntax highlighting
41-
- Do not include the query/mutation name in the header
41+
- Exclude the query/mutation name from the header
4242

4343
<CodeBlock title="Operation tab markdown format">
4444

src/content/docs/content/global.mdx

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,13 @@ title: Global style guide
44

55
import { Tooltip } from "@interledger/docs-design-system";
66

7-
:::caution
8-
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.
14-
15-
- [Web Monetization](/content/webmonetization)
16-
- [Rafiki](/content/rafiki)
17-
- [Open Payments](/content/openpayments)
18-
- Payment Pointers (not started)
19-
- [Interledger](/content/interledger) (not started)
7+
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.
208

219
## Rule #1
2210

2311
Break the rules.
2412

25-
Ok, try not to, but the audiences 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.
2614

2715
## Account servicing entity
2816

@@ -40,7 +28,7 @@ For buttons with labels/text strings, bold the text that appears in the button.
4028
- Click **Revoke public & private key**. ✅
4129
- Click on Revoke public & private key. ❌
4230

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:
4432

4533
- Click the arrow to proceed. ✅
4634
- 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
6553

6654
## Content reuse
6755

68-
Consider using MDX transclusion, also called MDX partials, if youre 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.
6957

7058
### /src/partials
7159

72-
Place MDX files to embed within the `/src/partials` folder. Create the folder if it doesnt exist.
60+
Place MDX partial files in the `/src/partials` folder. Create the folder if it doesn't exist.
7361

7462
### Partial files
7563

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.
7765

7866
Note:
7967

80-
- Dont 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.
8270
- Multiple partial files are supported within a single page.
8371

8472
### Embed a partial
@@ -89,9 +77,9 @@ First, import the partial file into the page:
8977
import NoPay from "/src/partials/glitchNoPay.mdx";
9078
```
9179

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`.
9381

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:
9583

9684
```mdx
9785
This is a paragraph of text. I want the partial content to appear beneath this paragraph.
@@ -140,37 +128,37 @@ https://moz.com/learn/seo/alt-text
140128
## Initialisms
141129

142130
- Capitalize each letter in an initialism.
143-
- 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.
144132
- In long pages, periodically spell out the entire phrase and include the initialism in parentheses. Long is subjective, use your best judgment.
145133
- If you use an initialism for a term that also appears in the glossary, add the initialism to the glossary term.
146-
- Dont 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.
147135

148136
## Lists
149137

150138
- Lists should typically contain a minimum of three items.
151139
- 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.
154142
- All items start with a noun, or all start with a verb.
155143
- All items have ending punctuation, or none do.
156144
- All items start with a capital letter, or all start with lowercase.
157145
- 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.
158146

159147
## Please
160148

161-
We're taking [Google's approach](https://developers.google.com/style/word-list#please): Dont use please in the normal course of explaining how to use a product, even if youre 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.
162150

163151
## See
164152

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*).
166154

167155
We've decided that it **is** OK to use *see*.
168156

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.
170158

171159
## SHA (secure hash algorithm)
172160

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.
174162

175163
When an a/an article is needed, use **a**.
176164

@@ -179,9 +167,9 @@ When an a/an article is needed, use **a**.
179167

180168
## Sidebar categories
181169

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.
183171

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.
185173

186174
For example:
187175

@@ -193,7 +181,7 @@ For example:
193181

194182
## Sidebar external links
195183

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.
197185

198186
```js
199187
sidebar: [
@@ -215,7 +203,7 @@ Always spell out test network. Don't abbreviate to testnet.
215203

216204
## Tooltips
217205

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 <Tooltip content='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 <Tooltip content='This is an example tooltip'><span>question mark</span></Tooltip>.
219207

220208
- Tooltips should be short. Consider linking to a page or glossary term instead of using the Tooltip component if a tooltip becomes too long.
221209
- Longer tooltips that appear at the top of the page might be cut off by the UI.

src/content/docs/content/markdown.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66

77
import { CodeBlock } from "@interledger/docs-design-system";
88

9-
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:
1010

1111
* https://starlight.astro.build/guides/authoring-content/
1212
* https://www.markdownguide.org/basic-syntax/
@@ -18,22 +18,24 @@ Frontmatter [YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) is
1818

1919
Escape a character by adding a backslash before the character.
2020

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:
2222

23-
`\{client_domain/jwks.json\}`
23+
`\{client_domain/jwks.json}`
2424

2525
## Frontmatter
2626

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.
3028

3129
```md
3230
---
3331
title: Remember to set this
3432
---
3533
```
3634

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+
3739
## Images
3840

3941
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
5052

5153
## Headings
5254

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.
5456

5557
### Automatic heading anchor links
5658

@@ -60,18 +62,16 @@ Level 2 (`<h2>`) and Level 3 (`<h3>`) headings automatically appear in a page's
6062

6163
## Advanced Markdown and MDX configuration
6264

63-
Starlight uses Astros 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.
6466

6567
### Mermaid diagrams
6668

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.
7070

7171
### Mathjax
7272

7373
:::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.
7575
:::
7676

7777
$currencyAmount = \frac{value}{10^{assetScale}}$

src/content/docs/content/openpayments.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ pnpm start
3636
### Proper nouns
3737

3838
- Interledger
39-
- Interledger Protocol (can be abbreviated to ILP after first use on a page)
40-
- Open Payments (always spell out, do not abbreviate as OP)
39+
- Interledger Protocol (can abbreviate as ILP after the first use on a page)
40+
- Open Payments (always spell out, don't abbreviate as OP)
4141
- Rafiki
42-
- Web Monetization (always spell out, do not abbreviate as WM)
42+
- Web Monetization (always spell out, don't abbreviate as WM)
4343

4444
## Spellings
4545

0 commit comments

Comments
 (0)