Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
17a0617
Setup check format in pipeline
brenelz Jan 3, 2025
a4cbf0a
Format files according to prettier
brenelz Jan 3, 2025
3157ff1
Merge branch 'main' into format-files
kodiakhq[bot] Jan 7, 2025
50e8d70
Merge branch 'main' into format-files
kodiakhq[bot] Jan 7, 2025
2e822c5
Merge branch 'main' into format-files
kodiakhq[bot] Jan 8, 2025
70f469a
Merge branch 'main' into format-files
kodiakhq[bot] Jan 9, 2025
a5b999a
Merge branch 'main' into format-files
kodiakhq[bot] Jan 10, 2025
27fad50
Merge branch 'main' into format-files
kodiakhq[bot] Jan 10, 2025
0367582
minor formatting fix to check i can push commits
amirhhashemi Feb 7, 2025
ca6a29a
fix formatting issues
amirhhashemi Feb 8, 2025
bbea460
Merge branch 'main' into format-files
amirhhashemi Feb 8, 2025
558d325
format with prettier
amirhhashemi Feb 8, 2025
ccb5a98
remove redundant space
amirhhashemi Feb 8, 2025
d0bfecd
Merge branch 'main' into format-files
kodiakhq[bot] Feb 10, 2025
4e9555e
Merge branch 'main' into format-files
kodiakhq[bot] Feb 13, 2025
4f5853d
Merge branch 'main' into format-files
amirhhashemi Feb 13, 2025
9e9cc0b
Merge branch 'main' into format-files
kodiakhq[bot] Feb 13, 2025
ded9a6e
format
amirhhashemi Feb 14, 2025
54ae1bb
add format script
amirhhashemi Feb 14, 2025
6bdb33b
Merge branch 'main' into format-files
amirhhashemi Feb 18, 2025
5bc9519
format
amirhhashemi Feb 18, 2025
de2f379
Merge branch 'main' into format-files
kodiakhq[bot] Feb 18, 2025
aa3fc1c
Merge branch 'main' into format-files
kodiakhq[bot] Feb 18, 2025
8788ed7
Merge branch 'main' into format-files
kodiakhq[bot] Feb 18, 2025
e884fa8
Commit changed files
amirhhashemi Feb 19, 2025
ae49991
Merge branch 'main' into format-files
amirhhashemi Mar 2, 2025
6b7f96a
format files
amirhhashemi Mar 2, 2025
addddb6
fix comment
amirhhashemi Mar 2, 2025
84e7b20
Add format workflow
amirhhashemi Mar 4, 2025
2d3bbf9
Add install action
amirhhashemi Mar 4, 2025
88375dc
Add shell property
amirhhashemi Mar 4, 2025
858b041
Remove setup step
amirhhashemi Mar 4, 2025
26c1cac
Use consitent pnpm command
amirhhashemi Mar 4, 2025
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
2 changes: 0 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
},
"plugins": ["@typescript-eslint", "solid"],
"rules": {
"quotes": ["error", "double"],
"semi": "warn",
"@typescript-eslint/no-unused-vars": [
"error",
{
Expand Down
16 changes: 5 additions & 11 deletions .github/ISSUE_TEMPLATE/BUGS.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
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
id: description
Expand All @@ -25,21 +19,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
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/OTHER.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
name: "Other Report 🌐"
title: "[Other]:"
description: Report something else we should know about the docs site!
labels: [
"pending review"
]
labels: ["pending review"]
body:
- type: textarea
id: issue
Expand All @@ -12,4 +10,4 @@ body:
description: Please describe the problem with the documentation in detail.
placeholder: "..."
validations:
required: true
required: true
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
21 changes: 21 additions & 0 deletions .github/actions/install/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Install Tools & Dependencies
description: Installs pnpm, Node.js & package dependencies

runs:
using: composite
steps:
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9
run_install: false

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- name: Install dependencies
run: pnpm install
shell: bash
24 changes: 24 additions & 0 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Format Files

on:
push:
branches:
- main

jobs:
setup:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Install tools & dependencies
uses: ./.github/actions/install

- name: Format files
run: pnpm format

- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "ci: Format files"
69 changes: 18 additions & 51 deletions .github/workflows/static_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,70 +2,37 @@ name: 🔍 Lint / Type Checks

on:
push:
branches: [main]
branches:
- main

pull_request:
branches: [main]
branches:
- main

jobs:
setup:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- run: pnpm i
- uses: actions/cache/save@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
Comment on lines -10 to -27
Copy link
Copy Markdown
Collaborator

@amirhhashemi amirhhashemi Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what's the goal in this job. It doesn't do anything useful that I can think of. So I removed it.

Comment on lines -22 to -27
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is needed to cache pnpm dependencies. See the official example.


typecheck:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- uses: actions/cache/restore@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: Check out code
uses: actions/checkout@v4

- name: Install tools & dependencies
uses: ./.github/actions/install

- name: Generate virtual modules
run: pnpm sync

- name: TypeScript check
run: pnpm check:types

lint:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- uses: actions/cache/restore@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: Check out code
uses: actions/checkout@v4

- name: Install tools & dependencies
uses: ./.github/actions/install

- name: ESLint check
run: pnpm check:lint
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
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
"build:lunaria": "lunaria build",
"preview:lunaria": "lunaria preview",
"check:lint": "eslint .",
"check:types": "tsc --noEmit"
"check:types": "tsc --noEmit",
"check:format": "prettier . --check",
"format": "prettier . --write"
},
"dependencies": {
"@kobalte/core": "^0.13.6",
Expand Down
Loading