Skip to content

Build: Apply docs formatting, add docs:check script #34330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kylegach merged 21 commits into from
Apr 16, 2026
Merged

Build: Apply docs formatting, add docs:check script #34330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
60b2113
Docs: Standardize formatting, add docs-review skill
kylegach Mar 26, 2026
ab00fcb
Chore: Add scripts for docs-review skill
kylegach Mar 26, 2026
c7c598b
Expand skill with more automated checks and writing standards
kylegach Mar 27, 2026
c3a0a7c
Run skill
kylegach Mar 27, 2026
6871ce8
Expand link check to handle anchors
kylegach Mar 27, 2026
1c7ccf4
Run skill
kylegach Mar 27, 2026
23de73e
Expand skill with more detailed voice and tone standards
kylegach Mar 30, 2026
c3ace6d
Run skill
kylegach Mar 30, 2026
fb4da21
Merge branch 'next' into docs-formatting
kylegach Mar 30, 2026
451c662
Replace fast-glob with tinyglobby
kylegach Mar 30, 2026
00c293d
Add weekly workflow
kylegach Mar 30, 2026
45b08a6
Rewrite skill to address structural/strategic issues, not just format…
kylegach Apr 2, 2026
d40a529
Merge branch 'next' into docs-formatting
kylegach Apr 2, 2026
7e992bf
Remove skill and workflow
kylegach Apr 2, 2026
3861704
Address feedback
kylegach Apr 2, 2026
9328fa2
Merge branch 'next' into docs-formatting
kylegach Apr 16, 2026
cb4f079
Address feedback
kylegach Apr 16, 2026
755d98d
Format
kylegach Apr 16, 2026
332d97f
Address feedback
kylegach Apr 16, 2026
752f00b
Address feedback
kylegach Apr 16, 2026
34dd9c0
Fix type error
kylegach Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .oxfmtrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,14 @@
"*.yaml",
"*.md",
"*.mdx",
"!docs/_snippets/**"
"!docs/**",
"docs/versions/**"
],
"overrides": [
{
"files": ["docs/_snippets/**"],
"files": ["docs/**"],
"options": {
"singleQuote": true,
"trailingComma": "all"
}
},
Expand Down
4 changes: 2 additions & 2 deletions docs/_snippets/button-story-with-addon-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ export const Basic: Story = {
});
</script>

<Story name="Basic"/>
<Story name="Basic" />
```

```js filename="Button.stories.js" renderer="svelte" language="js" tabTitle="CSF 3"
Expand Down Expand Up @@ -248,7 +248,7 @@ export const Basic = {};
});
</script>

<Story name="Basic"/>
<Story name="Basic" />
```

```ts filename="Button.stories.ts" renderer="svelte" language="ts" tabTitle="CSF 3"
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/component-story-custom-args-complex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ export const ExampleStory = {
};
},
template:
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty"/>',
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty" />',
};
},
args: {
Expand Down Expand Up @@ -499,7 +499,7 @@ export const ExampleStory: Story = {
};
},
template:
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty"/>',
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty" />',
};
},
args: {
Expand Down Expand Up @@ -720,7 +720,7 @@ export const ExampleStory = meta.story({
};
},
template:
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty"/>',
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty" />',
};
},
args: {
Expand Down Expand Up @@ -770,7 +770,7 @@ export const ExampleStory = meta.story({
};
},
template:
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty"/>',
'<YourComponent :propertyA="propertyA" :propertyB="propertyB" :someProperty="someProperty" />',
};
},
args: {
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/component-story-static-asset-cdn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ export default {
export const WithAnImage = {
render: () => ({
template:
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder"/>',
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder" />',
}),
};
```
Expand All @@ -216,7 +216,7 @@ type Story = StoryObj<typeof meta>;
export const WithAnImage: Story = {
render: () => ({
template:
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder"/>',
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder" />',
}),
};
```
Expand All @@ -233,7 +233,7 @@ const meta = preview.meta({
export const WithAnImage = meta.story({
render: () => ({
template:
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder"/>',
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder" />',
}),
});
```
Expand All @@ -252,7 +252,7 @@ const meta = preview.meta({
export const WithAnImage = meta.story({
render: () => ({
template:
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder"/>',
'<img src="https://storybook.js.org/images/placeholders/350x150.png" alt="My CDN placeholder" />',
}),
});
```
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/component-story-static-asset-with-import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ export const WithAnImage = {
//👇 Returns the content of the image object created above.
return { image };
},
template: `<img v-bind="image"/>`,
template: `<img v-bind="image" />`,
}),
};
```
Expand Down Expand Up @@ -288,7 +288,7 @@ export const WithAnImage: Story = {
//👇 Returns the content of the image object created above.
return { image };
},
template: `<img v-bind="image"/>`,
template: `<img v-bind="image" />`,
}),
};
```
Expand All @@ -315,7 +315,7 @@ export const WithAnImage = meta.story({
//👇 Returns the content of the image object created above.
return { image };
},
template: `<img v-bind="image"/>`,
template: `<img v-bind="image" />`,
}),
});
```
Expand Down Expand Up @@ -344,7 +344,7 @@ export const WithAnImage = meta.story({
//👇 Returns the content of the image object created above.
return { image };
},
template: `<img v-bind="image"/>`,
template: `<img v-bind="image" />`,
}),
});
```
Expand Down
6 changes: 3 additions & 3 deletions docs/_snippets/custom-docs-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ If you didn't include the title in the story's default export, use this approach

### Primary

<Story id="your-directory-button--primary"/>
<Story id="your-directory-button--primary" />

### Secondary

<Story id="your-directory-button--secondary"/>
<Story id="your-directory-button--secondary" />

### Large

<Story id="your-directory-button--large"/>
<Story id="your-directory-button--large" />

### Small

Expand Down
24 changes: 12 additions & 12 deletions docs/_snippets/list-story-reuse-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,9 +304,9 @@ export const ManyItems = {
},
template: `
<List v-bind="args">
<list-item :isSelected="Selected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Selected" />
<list-item :isSelected="Unselected" />
<list-item :isSelected="Unselected" />
</List>`,
}),
args: {
Expand Down Expand Up @@ -340,9 +340,9 @@ export const ManyItems: Story = {
},
template: `
<List v-bind="args">
<list-item :isSelected="Selected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Selected" />
<list-item :isSelected="Unselected" />
<list-item :isSelected="Unselected" />
</List>`,
}),
args: {
Expand Down Expand Up @@ -373,9 +373,9 @@ export const ManyItems = meta.story({
},
template: `
<List v-bind="args">
<list-item :isSelected="Selected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Selected" />
<list-item :isSelected="Unselected" />
<list-item :isSelected="Unselected" />
</List>`,
}),
args: {
Expand Down Expand Up @@ -408,9 +408,9 @@ export const ManyItems = meta.story({
},
template: `
<List v-bind="args">
<list-item :isSelected="Selected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Unselected"/>
<list-item :isSelected="Selected" />
<list-item :isSelected="Unselected" />
<list-item :isSelected="Unselected" />
</List>`,
}),
args: {
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/list-story-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ const ListTemplate = {
template: `
<List v-bind="args">
<div v-for="item in items" :key="item.title">
<ListItem :item="item"/>
<ListItem :item="item" />
</div>
</List>
`,
Expand Down Expand Up @@ -417,7 +417,7 @@ export const ListTemplate: Story = {
template: `
<List v-bind="args">
<div v-for="item in items" :key="item.title">
<ListItem :item="item"/>
<ListItem :item="item" />
</div>
</List>
`,
Expand Down Expand Up @@ -460,7 +460,7 @@ export const Empty = meta.story({
template: `
<List v-bind="args">
<div v-for="item in items" :key="item.title">
<ListItem :item="item"/>
<ListItem :item="item" />
</div>
</List>
`,
Expand Down Expand Up @@ -501,7 +501,7 @@ export const Empty = meta.story({
template: `
<List v-bind="args">
<div v-for="item in items" :key="item.title">
<ListItem :item="item"/>
<ListItem :item="item" />
</div>
</List>
`,
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/list-story-unchecked.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export const OneItem = {
//👇 The args will now be passed down to the template
return { args };
},
template: '<List v-bind="args"><ListItem v-bind="args"/></List>',
template: '<List v-bind="args"><ListItem v-bind="args" /></List>',
}),
};
```
Expand Down Expand Up @@ -231,7 +231,7 @@ export const OneItem: Story = {
//👇 The args will now be passed down to the template
return { args };
},
template: '<List v-bind="args"><ListItem v-bind="args"/></List>',
template: '<List v-bind="args"><ListItem v-bind="args" /></List>',
}),
args: {
...Unchecked.args,
Expand Down Expand Up @@ -264,7 +264,7 @@ export const OneItem = meta.story({
//👇 The args will now be passed down to the template
return { args };
},
template: '<List v-bind="args"><ListItem v-bind="args"/></List>',
template: '<List v-bind="args"><ListItem v-bind="args" /></List>',
}),
args: {
...Unchecked.input.args,
Expand Down Expand Up @@ -299,7 +299,7 @@ export const OneItem = meta.story({
//👇 The args will now be passed down to the template
return { args };
},
template: '<List v-bind="args"><ListItem v-bind="args"/></List>',
template: '<List v-bind="args"><ListItem v-bind="args" /></List>',
}),
args: {
...Unchecked.input.args,
Expand Down
8 changes: 4 additions & 4 deletions docs/_snippets/my-component-story-basic-and-props.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ export const Basic = {
export const WithProp = {
render: () => ({
components: { MyComponent },
template: '<MyComponent prop="value"/>',
template: '<MyComponent prop="value" />',
}),
};
```
Expand All @@ -278,7 +278,7 @@ export const Basic: Story = {
export const WithProp: Story = {
render: () => ({
components: { MyComponent },
template: '<MyComponent prop="value"/>',
template: '<MyComponent prop="value" />',
}),
};
```
Expand All @@ -302,7 +302,7 @@ export const Basic = meta.story({
export const WithProp = meta.story({
render: () => ({
components: { MyComponent },
template: '<MyComponent prop="value"/>',
template: '<MyComponent prop="value" />',
}),
});
```
Expand All @@ -326,7 +326,7 @@ export const Basic = meta.story({
export const WithProp = meta.story({
render: () => ({
components: { MyComponent },
template: '<MyComponent prop="value"/>',
template: '<MyComponent prop="value" />',
}),
});
```
Expand Down
Loading
Loading