Skip to content

Commit 8d7cf1b

Browse files
committed
Merge branch 'master' into add-vim-mode
2 parents f492385 + 44c2456 commit 8d7cf1b

File tree

762 files changed

+130151
-23652
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

762 files changed

+130151
-23652
lines changed

.babelrc

Lines changed: 0 additions & 7 deletions
This file was deleted.

.env

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
VERSION_LATEST="v11.0.0"
2+
VERSION_NEXT="v12.0.0"

.gitattributes

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.res linguist-language=ReScript
2+
*.resi linguist-language=ReScript
3+
4+
/public/playground-bundles/** binary linguist-vendored

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🚀 rescript-compiler
4+
url: https://github.com/rescript-lang/rescript/issues
5+
about: Please report problems about the ReScript compiler, build system and tools here.
6+
- name: 💻 rescript-vscode
7+
url: https://github.com/rescript-lang/rescript-vscode/issues
8+
about: VSCode language support, LSP
9+
- name: 📦 create-rescript-app
10+
url: https://github.com/rescript-lang/create-rescript-app/issues
11+
about: ReScript's project generator
12+
- name: ⚛️ rescript-react
13+
url: https://github.com/rescript-lang/rescript-react/issues
14+
about: ReScript bindings to React.js
15+
- name: 🌐 rescript-core
16+
url: https://github.com/rescript-lang/rescript-core/issues
17+
about: New ReScript standard library
18+
- name: 💬 ReScript Forum
19+
url: https://forum.rescript-lang.org/
20+
about: For discussions about ReScript, please visit the official ReScript forum.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: 🚨 Documentation issue
3+
about: Create an issue to help us improve the rescript-lang.org documentation website
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+

.github/workflows/pull-request.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ jobs:
44
build:
55
runs-on: ubuntu-latest
66
steps:
7-
- uses: actions/checkout@v2
8-
- uses: actions/setup-node@v2
7+
- uses: actions/checkout@v4
8+
- uses: actions/setup-node@v4
99
with:
10-
node-version: 14.x
10+
node-version: 20
11+
cache: npm
1112
- run: npm ci
1213
- run: npx rescript
1314
- run: npm test

.gitignore

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ public/blog/feed.xml
77

88
node_modules/
99
.next/
10+
out/
1011
index_data/*.json
1112

1213
# Generated via test examples script
@@ -15,8 +16,8 @@ _tempFile.cmj
1516
_tempFile.cmt
1617

1718
# these docs are checked in, but we consider them frozen.
18-
pages/docs/manual/v8.0.0/
19-
pages/docs/manual/v9.0.0/
19+
# pages/docs/manual/v8.0.0/
20+
# pages/docs/manual/v9.0.0/
2021

2122
.bsb.lock
2223
.merlin
@@ -26,3 +27,13 @@ lib/
2627
.vercel
2728

2829
src/**/*.mjs
30+
scripts/gendocs.mjs
31+
scripts/generate_*.mjs
32+
33+
# Generated via generate-llms script
34+
public/llms/manual/**/llm*.txt
35+
public/llms/react/**/llm*.txt
36+
pages/docs/**/**/llms.mdx
37+
38+
public/playground-bundles/
39+
public/_redirects

.node-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22.11.0

.nowignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
66

77
## Ways to contribute
88

9-
- Writing docs for the manual (Check for issues that are marked with a [`manual`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"manual") and [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") tag)
10-
- Joining in discussions on our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues)
9+
- Writing docs for the manual (Check for issues that are marked with a [`manual`](https://github.com/rescript-lang/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"manual") and [`help wanted`](https://github.com/rescript-lang/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") tag)
10+
- Joining in discussions on our [issue tracker](https://github.com/rescript-lang/rescript-lang.org/issues)
1111
- Give feedback for improvements (incomplete / missing docs, bad wording,
1212
search user experience / design, etc.)
1313
- Advanced: Help building platform features (design system, automatic testing, markdown parsing, etc.)
@@ -16,35 +16,35 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
1616

1717
### Find an issue
1818

19-
Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues) for any issues or discussions on the topic.
19+
Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/rescript-lang/rescript-lang.org/issues) for any issues or discussions on the topic.
2020

2121
If you can't find any relevant issues, feel free to create a new one to start a discussion. We usually assign issues to a responsible person to prevent confusion and duplicate work, so always double check if an issue is currently being worked on, or talk to the current assignee to take over the task.
2222

2323
**Always make sure to get feedback from the core maintainers before starting any work**
2424

2525
The project follows very specific goals and tries to deliver the highest value with the least amount of resources. Please help us focus on the tasks at hand and don't submit any code / bigger refactorings without any proper discussion on the issue tracker. Otherwise your PR might not be accepted!
2626

27-
If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") or [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted").
27+
If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/rescript-lang/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") or [`help wanted`](https://github.com/rescript-lang/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted").
2828

2929
### Discuss an issue
3030

3131
We really appreciate all input from users, community members and potential contributors. Please make sure to consider the other person's opinion and don't assume any common knowledge.
3232

33-
**Most importantly: Keep it professional and be nice to each other**
33+
**Most importantly: Keep it professional and be nice to eachother**
3434

35-
There might be situations where others don't understand a proposed feature or have different opinions on certain writing styles. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always stick to the original topic.
35+
There might be situations where others don't understand a proposed feature or have different opinions on certain writing styles. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always to stick to the original topic.
3636

3737
If other contributors disagree with certain proposals and don't change their mind after longer discussions, please don't get discouraged when an issue gets closed / postponed. Everyone tries their best to make the platform better, and to look at it in another perspective: Closed issues are also a highly valuable resource for others to understand technical decisions later on.
3838

3939
### Communicate your Time Commitment
4040

4141
Open Source development can be a challenge to coordinate, so please make sure to block enough time to work on your tasks and show commitment when taking on some work. Let other contributors know if your time schedule changes significantly, and also let others know if you can't finish a task.
4242

43-
We value your voluntary work, and of course it's fine to step back from a ticket for any reason (we can also help you if you are getting stuck). Please talk to us in any case, otherwise we might re-assign the ticket to other contributors.
43+
We value your voluntary work, and of course it's fine to step back from a ticket for any reasons (we can also help you if you are getting stuck). Please talk to us in any case, otherwise we might re-assign the ticket to other contributors.
4444

4545
### Communication Channels
4646

47-
- [Issue Tracker](https://github.com/reason-association/rescript-lang.org/issues)
47+
- [Issue Tracker](https://github.com/rescript-lang/rescript-lang.org/issues)
4848
- [ReScript Discourse (General / mostly unrelated discussions)](http://forum.rescript-lang.org)
4949

5050
## Working on the rescript-lang.org
@@ -55,7 +55,7 @@ We try to keep our contribution guidelines to a minimum. Please keep following r
5555

5656
The less code we write, the better. If there's a way to do rendering on the server, or enhance existing markdown files, we prefer that over client-side rendering and external loading.
5757

58-
We also try to keep our third-party dependencies to a minimum. We use specific frameworks to make things work (`unified`, `remark`, `mdx`, `bs-platform`, etc). Please try to keep a small JS footprint, especially for client side code (to keep the bundle size small).
58+
We also try to keep our third-party dependencies to a minimum. We use specific frameworks to make things work (`unified`, `remark`, `mdx`, `bs-platform`, etc). Please try to keep a small JS footprint, especially for client side code (to keep the bundle size small).
5959

6060
### Think about the target audience & UX
6161

@@ -66,13 +66,13 @@ Always check if there are any designs for certain UI components and think about
6666
### Technical Writing (Documentation)
6767

6868
- Think and write in a JS friendly mindset when explaining concepts / showing examples.
69-
- No `foo` examples if somewhat possible. Try to establish practical context in your showcase examples.
69+
- No `foo` examples if somewhat possible. Try to establish practical context in your show case examples.
7070
- No references to `OCaml`. ReScript is its own language, and we don't rely on external resources of our host language.
7171
- If possible, no references to `Reason` examples / external resources. Our goal is to migrate everything to ReScript syntax.
7272

7373
### Tailwind for CSS Development
7474

75-
We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check out the [tailwind.config.js](tailwind.config.js) file for configured tailwind features, colors, border-radius values etc.. If you are not familiar with Tailwind, check out existing components for inspiration.
75+
We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check out the [tailwind.config.js](tailwind.config.js) file for configured tailwind features, colors, border-radius values etc.. If you are not familiar with Tailwind, check out existing components for inspiration.
7676

7777
We sometimes also need to fall back to common css (with tailwind `@apply` directives to enforce our style system). You can find the CSS main entrypoint in [styles/main.css](styles/main.css).
7878

0 commit comments

Comments
 (0)