Skip to content

Commit

Permalink
Format files according to prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
brenelz committed Jan 3, 2025
1 parent 17a0617 commit a4cbf0a
Show file tree
Hide file tree
Showing 183 changed files with 8,187 additions and 5,381 deletions.
16 changes: 4 additions & 12 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
{
"ignorePatterns": [
"node_modules/",
"dist/"
],
"ignorePatterns": ["node_modules/", "dist/"],
"env": {
"browser": true,
"es2021": true
Expand All @@ -17,9 +14,7 @@
"env": {
"node": true
},
"files": [
".eslintrc.{js,cjs}"
],
"files": [".eslintrc.{js,cjs}"],
"parserOptions": {
"sourceType": "script"
}
Expand All @@ -30,10 +25,7 @@
"ecmaVersion": "latest",
"sourceType": "module"
},
"plugins": [
"@typescript-eslint",
"solid"
],
"plugins": ["@typescript-eslint", "solid"],
"rules": {
"@typescript-eslint/no-unused-vars": [
"error",
Expand All @@ -48,4 +40,4 @@
}
]
}
}
}
17 changes: 7 additions & 10 deletions .github/ISSUE_TEMPLATE/BUGS.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
name: "Bug Report 🪲"
description: Report an issue or possible bug with the functionality of the Solid docs website. (Not related to the content of the site.)
title: "[Bug]: "
labels: [
"bug",
"pending review"
]
assignees:
- danieljcafonso
- atilafassina
labels: ["bug", "pending review"]
assignees:
- danieljcafonso
- atilafassina

body:
- type: textarea
Expand All @@ -25,21 +22,21 @@ body:
description: Please indicate on which page(s) the issue occurs.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: true
required: true
- type: textarea
id: expected
attributes:
label: "🤔 Expected Behavior"
description: Please describe what the expected behavior should be.
placeholder: When on this page, I expected . . .
placeholder: When on this page, I expected . . .
validations:
required: true
- type: textarea
id: current
attributes:
label: "👀 Current Behavior"
description: Please describe what the current behavior is.
placeholder: But instead, on this page I'm noticing . . .
placeholder: But instead, on this page I'm noticing . . .
validations:
required: true
- type: input
Expand Down
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE/CONTENT.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
name: "Content Report 📄"
title: "[Content]:"
description: Report an issue with existing content.
labels: [
"improve documentation", "pending review"
]
assignees:
- ladybluenotes
labels: ["improve documentation", "pending review"]
assignees:
- ladybluenotes
body:
- type: markdown
attributes:
Expand All @@ -25,19 +23,19 @@ body:
description: Please provide the URL of the page(s) affected.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: true
required: true
- type: textarea
id: generalDesc
attributes:
label: "📋 Description of content that is out-of-date or incorrect"
description: Let us know what's wrong!
placeholder: "..."
validations:
required: true
required: true
- type: textarea
id: incorrectContent
attributes:
label: "🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)"
description: If you are reporting incorrect content or code samples, you can also attach a reproduction in stackblitz.
validations:
required: false
required: false
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE/REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
name: "Request 💡"
title: "[Request]:"
description: Share an idea.
labels: [
"request", "pending review"
]
labels: ["request", "pending review"]
assignees:
- ladybluenotes
- ladybluenotes
body:
- type: markdown
attributes:
Expand All @@ -14,7 +12,7 @@ body:
id: request-topic
attributes:
label: "What is this request related to?"
options:
options:
- Request
- Styling
- Feature
Expand All @@ -27,20 +25,20 @@ body:
description: Please provide the URL of the page(s) or section this idea is related to.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: false
required: false
- type: textarea
id: generalDesc
attributes:
label: "📋 General description or bullet points"
description: Please provide a general description or bullet points about what you would like to see added.
placeholder: "..."
validations:
required: true
required: true
- type: textarea
id: example
attributes:
label: "🖥️ Reproduction of code samples in StackBlitz"
description: If you would like to suggest code samples please attach a working reproduction.
placeholder: "..."
validations:
required: false
required: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: true
contact_links:
- name: Support & Community 💁
url: https://discord.com/invite/solidjs
about: 'This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!'
about: "This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!"
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [ ] This PR references an issue (except for typos, broken links, or other minor problems)

### Description(required)

<!-- Provide a detailed description of the changes in this PR. Why is it necessary, and what does it do? -->

### Related issues & labels
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,13 @@ Though it is not a hard requirement, we'd deeply appreciate if you could recomme

1. Create a dictionary file in `src/i18n/dictionaries/{locale}/ui.ts`. The name should follow our locale convention.

- language (ISO 639-1 - set 1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
- country code(optional) (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
- E.g.: Canadian French would be: `fr-ca`
- language (ISO 639-1 - set 1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
- country code(optional) (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
- E.g.: Canadian French would be: `fr-ca`

2. Add the `import` and language information to the objects in the barrel file: `./src/i18n/dictionaries/index.ts`. So it will be identified by the routing system, and an entry its added to the language dropdown.
3. Add the language to the `array` in `./scripts/collections/index.mjs` so internal files are created.
4. Add the important UI translations to `./src/i18n/dictionaries/{locale}/ui.ts`
4. Add the important UI translations to `./src/i18n/dictionaries/{locale}/ui.ts`
5. Add at least the index page `./src/routes/{locale}/index.mdx`, so others and yourself could see things in action.

#### Adding translations to a supported language
Expand Down
2 changes: 1 addition & 1 deletion lunaria.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"site": "https://docs.solidjs.com/i18n-status",
"title": "Solid Docs Translation Status",
"description": "Translation progress tracker for the Solid Docs site",
"basesToHide": ["src/routes/", "src/i18n/dictionaries/"],
"basesToHide": ["src/routes/", "src/i18n/dictionaries/"],
"favicon": {
"external": [
{
Expand Down
Loading

0 comments on commit a4cbf0a

Please sign in to comment.