Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
31 changes: 31 additions & 0 deletions .github/workflows/autofix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: autofix.ci

on:
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
cancel-in-progress: true

permissions:
contents: write

jobs:
autofix:
name: autofix
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.0
with:
fetch-depth: 0
- name: Setup Tools
uses: ./.github/actions/install
- name: Fix lint issues
run: pnpm lint:fix
- name: Fix formatting
run: pnpm format
- name: Apply fixes
uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27
with:
commit-message: "ci: apply automated fixes"
7 changes: 5 additions & 2 deletions .github/workflows/static_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
uses: actions/checkout@v5

- name: Install tools & dependencies
uses: ./.github/actions/install
Expand All @@ -33,10 +33,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
uses: actions/checkout@v5

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

- name: Lint code
run: pnpm check:lint

- name: Check formatting
run: pnpm exec prettier . --check
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.solid
dist
*.min.*
package-lock.json
package-lock.json
.github/ISSUE_TEMPLATE/OTHER.yml
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"semi": true,
"singleQuote": false,
"useTabs": true,
"plugins": ["prettier-plugin-tailwindcss"]
"plugins": ["prettier-plugin-tailwindcss"]
}
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
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
<img src="https://assets.solidjs.com/banner?project=Solid%20Documentation&type=core" alt="Solid Documentation" />
</p>


Welcome to Solid's documentation!

This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
Expand Down
2 changes: 2 additions & 0 deletions WRITING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,13 +194,15 @@ Reference pages document the API surface.
Keep them concise and easy to scan.

Include:

- Imports
- Signatures
- Parameters
- Return values
- Short examples

Avoid:

- Narrative context or “why”
- Usage guidance (“when to use”, best practices)
- Long notes
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
"build:sitemap": "node scripts/generateSitemap.js",
"start": "vinxi start",
"e2e": "npx playwright test",
"format": "prettier . --write",
"lint:fix": "eslint --flag unstable_native_nodejs_ts_config . --fix",
"check:lint": "eslint --flag unstable_native_nodejs_ts_config .",
"check:types": "tsc --noEmit"
},
Expand Down
Loading