Skip to content

Commit 3ae0e88

Browse files
authored
docs: minor updates (#1661)
* docs: minor updates * update prettier
1 parent a925071 commit 3ae0e88

File tree

7 files changed

+27
-34
lines changed

7 files changed

+27
-34
lines changed

.cspell.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"styfle",
5757
"stylelint",
5858
"svgr",
59+
"syncer",
5960
"tagend",
6061
"tagname",
6162
"tagstart",
@@ -65,6 +66,7 @@
6566
"ufff",
6667
"uffff",
6768
"unmin",
69+
"unstale",
6870
"webp",
6971
"withastro",
7072
"xiang",

.cursor/rules/general.mdc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
description:
3+
globs:
4+
alwaysApply: true
5+
---
6+
- When adding a new rule to website ensure that it has the frontmatter: `pagefind: false sidebar: badge: New hidden: true`
7+
- Always run `npm run lint` before declaring that a task is complete (if you've changed any files)
8+

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,16 @@ name: Bug report
33
about: Create a report to help us improve
44
---
55

6-
**Describe the bug**
7-
A clear and concise description of what the bug is.
6+
## Describe the bug
87

9-
**To Reproduce**
10-
Steps to reproduce the behavior:
8+
<!-- A clear and concise description of what the bug is. -->
9+
<!-- Add any other context about the problem here. -->
1110

12-
1. Go to '...'
13-
2. Click on '....'
14-
3. Scroll down to '....'
15-
4. See error
11+
## To Reproduce
1612

17-
**Expected behavior**
18-
A clear and concise description of what you expected to happen.
13+
<!--Steps to reproduce the behavior: -->
14+
<!-- If applicable, add screenshots to help explain your problem. -->
1915

20-
**Screenshots**
21-
If applicable, add screenshots to help explain your problem.
16+
## Expected behavior
2217

23-
**Desktop (please complete the following information):**
24-
25-
- OS: [e.g. iOS]
26-
- Browser [e.g. chrome, safari]
27-
- Version [e.g. 22]
28-
29-
**Smartphone (please complete the following information):**
30-
31-
- Device: [e.g. iPhone6]
32-
- OS: [e.g. iOS8.1]
33-
- Browser [e.g. stock browser, safari]
34-
- Version [e.g. 22]
35-
36-
**Additional context**
37-
Add any other context about the problem here.
18+
<!-- A clear and concise description of what you expected to happen. -->

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Use ESLint to check for JavaScript errors.
88
- Rollup is used for building the project.
99
- Node v20 is used for development.
10-
- Core code is in TypeScript v4.
10+
- Core code is in TypeScript v5.4.5.
1111
- All new rules for HTMLHint should be placed in the rules directory.
1212
- Tests for new rules should be added in rules and follow the naming pattern <rule-name>.spec.js.
1313
- Do not use deprecated Node.js or TypeScript features.

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ report.html
2828
# Miscellaneous
2929
CODEOWNERS
3030
*.txt
31+
.cspell.json
3132

3233
## Website
3334
/website/.astro

.prettierrc.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"semi": false,
3-
"singleQuote": true,
42
"bracketSpacing": true,
53
"embeddedLanguageFormatting": "off",
6-
"trailingComma": "es5",
7-
"useTabs": false,
4+
"printWidth": 80,
5+
"semi": false,
6+
"singleQuote": true,
87
"tabWidth": 2,
9-
"printWidth": 80
8+
"trailingComma": "es5",
9+
"useTabs": false
1010
}

website/src/content/docs/rules/tag-no-obsolete.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
id: tag-no-obsolete
33
title: tag-no-obsolete
44
description: Disallows the use of obsolete HTML5 tags that are no longer supported in modern browsers.
5+
pagefind: false
56
sidebar:
67
badge: New
7-
hidden: true
8+
hidden: true
89
---
910

1011
import { Badge } from '@astrojs/starlight/components';

0 commit comments

Comments
 (0)