Skip to content

Update github links #926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ contact_links:
url: https://github.com/rescript-lang/rescript-react/issues
about: ReScript bindings to React.js
- name: 🌐 rescript-core
url: https://github.com/rescript-association/rescript-core/issues
url: https://github.com/rescript-lang/rescript-core/issues
about: New ReScript standard library
- name: 💬 ReScript Forum
url: https://forum.rescript-lang.org/
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make

## Ways to contribute

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

### Find an issue

Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/rescript-association/rescript-lang.org/issues) for any issues or discussions on the topic.
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.

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.

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

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!

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

### Discuss an issue

Expand All @@ -44,7 +44,7 @@ We value your voluntary work, and of course it's fine to step back from a ticket

### Communication Channels

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

## Working on the rescript-lang.org
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |
Update on what we're doing around the end of 2020 and early next year.
---

import Video from "src/components/Video"
import Video from "src/components/Video";

## Upcoming Improvements

Expand All @@ -28,7 +28,7 @@ Hongbo continues to improve the compiler experience in monorepo-like setups. Exp

## Docs

Patrick is [rearranging the React documentation](https://github.com/rescript-association/rescript-lang.org/pull/96), and continues to improve the main documentation site with Cheng Lou.
Patrick is [rearranging the React documentation](https://github.com/rescript-lang/rescript-lang.org/pull/96), and continues to improve the main documentation site with Cheng Lou.

## Syntax

Expand Down
3 changes: 2 additions & 1 deletion _blogposts/2021-03-03-rescript-association-rebranding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Founded in 2018, the ReScript Association provides a legal and financial foundat
- [rescript-lang.org](https://rescript-lang.org).
- [Community forum](https://forum.rescript-lang.org) & server.
- ReScript related domains and [analytics data](https://simpleanalytics.com/rescript-lang.org).
- [genType’s](https://github.com/rescript-association/genType) release automation.
- [genType’s](https://github.com/rescript-lang/genType) release automation.
- Help maintaining editor related tools such as [rescript-vscode](https://github.com/rescript-lang/rescript-vscode), [vim-rescript](https://github.com/rescript-lang/vim-rescript) and the underlying [editor-support](https://github.com/rescript-lang/rescript-editor-support).
- Design & logo assets (together with our designer) for all of ReScript.
- Helping out on upcoming [ocaml.org](https://ocaml.org) work.
Expand All @@ -48,6 +48,7 @@ High quality, long-term Open Source work doesn’t come from some good words and
If your company relies on the ReScript platform for building commercial products, please consider supporting our efforts by [sending a donation](https://rescript-association.org/donate). It’s the best way to future proof your product’s foundation. Alternatively, you can sponsor individual members like [ryyppy](https://github.com/sponsors/ryyppy/) on GitHub Sponsors.

We want to take this opportunity to thank our previous and active sponsors:

- [Tezos Foundation](https://tezos.foundation) (2020-21)
- [Ahrefs](https://ahrefs.com) (2019)
- [OCaml Software Foundation](https://ocaml-sf.org) (2018-19)
Expand Down
12 changes: 8 additions & 4 deletions _blogposts/2021-06-25-roadmap-2021-and-new-landing-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It has almost been a year since we originally [launched our new ReScript brand](
- Accessible object system (no need for `Js.t`)
- The release of our new `rescript` npm package and cli to replace `bs-platform`
- Making every part of ReScript fully community owned
- etc.
- etc.

Stay tuned, this is just the beginning!

Expand All @@ -30,6 +30,7 @@ Stay tuned, this is just the beginning!
We had some thorough discussions about the future of the project and outlined the most important milestones for the next upcoming releases.

**Here's the gist:**

- Two release channels: `stable` and `experimental`
- More predictable release dates and better migration steps
- Better communication and discussion for breaking changes
Expand All @@ -41,15 +42,18 @@ The detailed roadmap with all our planned changes (and definition of our release

After several iterations, we are happy to announce our new [landing page](/).

<Image src="/static/img/landing_page_figma.png" withShadow={true} caption="Figma design draft for the new landing page"/>
<Image
src="/static/img/landing_page_figma.png"
withShadow={true}
caption="Figma design draft for the new landing page"
/>

This is an incredible milestone for the documentation, and will act as a foundation for some cool new future improvements, such as:

- Highlighted Case Studies from production users such as Beop or Rohea
- An interactive playground widget for the headline code examples
- New starter templates and guides


Furthermore, in case you are a **production user of ReScript** and you want to see your company logo highlighted on the landing page, please [open an issue](https://github.com/rescript-association/rescript-lang.org/issues) and let us know!
Furthermore, in case you are a **production user of ReScript** and you want to see your company logo highlighted on the landing page, please [open an issue](https://github.com/rescript-lang/rescript-lang.org/issues) and let us know!

Happy hacking.
2 changes: 1 addition & 1 deletion _blogposts/2023-02-02-release-10-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,6 @@ As always, we want to thank our [contributors](https://github.com/rescript-lang/

We hope you enjoy the newest improvements as much as we do.

In case there's any issues / problems, make sure to report bugs to [rescript-lang/rescript-compiler](https://github.com/rescript-lang/rescript-compiler) (language / syntax / jsx), [rescript-lang/rescript-react](https://github.com/rescript-lang/rescript-react) (React 16 / 18 binding) or [rescript-association/rescript-lang.org](https://github.com/rescript-association/rescript-lang.org) (documentation) repositories.
In case there's any issues / problems, make sure to report bugs to [rescript-lang/rescript-compiler](https://github.com/rescript-lang/rescript-compiler) (language / syntax / jsx), [rescript-lang/rescript-react](https://github.com/rescript-lang/rescript-react) (React 16 / 18 binding) or [rescript-association/rescript-lang.org](https://github.com/rescript-lang/rescript-lang.org) (documentation) repositories.

Also feel free to visit the [ReScript forum](https://forum.rescript-lang.org/) to ask questions and connect with other ReScripters.
2 changes: 1 addition & 1 deletion _blogposts/2023-04-17-improving-interop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ let getBestFriendsAge = user =>
As you can see, you need to convert each level of nullables explicitly, which makes it hard to fully utilize pattern matching. With the new unboxed variant representation, we'll instead be able to do this:

```rescript
// The type definition below is inlined here to examplify, but this definition will live in [Core](https://github.com/rescript-association/rescript-core) and be easily accessible
// The type definition below is inlined here to examplify, but this definition will live in [Core](https://github.com/rescript-lang/rescript-core) and be easily accessible
module Null = {
@unboxed type t<'a> = Present('a) | @as(null) Null
}
Expand Down
4 changes: 2 additions & 2 deletions _blogposts/2024-01-11-release-11-0-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This release is also introducing uncurried mode, which is a new default mode tha

### New Standard Library: ReScript Core

[ReScript Core](https://github.com/rescript-association/rescript-core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode.
[ReScript Core](https://github.com/rescript-lang/rescript-core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode.

The latest docs on [rescript-lang.org](/) already use it for the examples. Have a look at the new [RescriptCore API docs](/docs/manual/latest/api/core).

Expand Down Expand Up @@ -149,4 +149,4 @@ In case of issues / problems, make sure to report bugs to one of the following r
- [rescript-lang/rescript-react](https://github.com/rescript-lang/rescript-react) (React bindings)
- [rescript-lang/rescript-vscode](https://github.com/rescript-lang/rescript-vscode) (VSCode language support, LSP, tools)
- [rescript-lang/create-rescript-app](https://github.com/rescript-lang/create-rescript-app) (project generator) or
- [rescript-association/rescript-lang.org](https://github.com/rescript-association/rescript-lang.org) (documentation)
- [rescript-association/rescript-lang.org](https://github.com/rescript-lang/rescript-lang.org) (documentation)
4 changes: 2 additions & 2 deletions misc_docs/syntax/decorator_dead.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ summary: "This is the `@dead` decorator."
category: "decorators"
---

> This decorator requires [`reanalyze`](https://github.com/rescript-association/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-association/reanalyze).
> This decorator requires [`reanalyze`](https://github.com/rescript-lang/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-lang/reanalyze).

`@dead` is picked up by reanalyze's dead code analysis, and suppresses reporting on the value/type, but can also be used to force the analysis to consider a value as dead. Typically used to acknowledge cases of dead code you are not planning to address right now, but can be searched easily later.

### References

- [Reanalyze: Controlling reports with Annotations](https://github.com/rescript-association/reanalyze#dce-controlling-reports-with-annotations)
- [Reanalyze: Controlling reports with Annotations](https://github.com/rescript-lang/reanalyze#dce-controlling-reports-with-annotations)
4 changes: 2 additions & 2 deletions misc_docs/syntax/decorator_does_not_raise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ summary: "This is the `@doesNotRaise` decorator."
category: "decorators"
---

> This decorator requires [`reanalyze`](https://github.com/rescript-association/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-association/reanalyze).
> This decorator requires [`reanalyze`](https://github.com/rescript-lang/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-lang/reanalyze).

`@doesNotRaise` is used to override the reanalyze's exception analysis and state that an expression does not raise any exceptions, even though the analysis reports otherwise. This can happen for example in the case of array access where the analysis does not perform range checks but takes a conservative stance that any access could potentially raise.

### References

- [Reanalyze: Exception Analysis](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md)
- [Reanalyze: Exception Analysis](https://github.com/rescript-lang/reanalyze/blob/master/EXCEPTION.md)
4 changes: 2 additions & 2 deletions misc_docs/syntax/decorator_live.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ summary: "This is the `@live` decorator."
category: "decorators"
---

> This decorator requires [`reanalyze`](https://github.com/rescript-association/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-association/reanalyze).
> This decorator requires [`reanalyze`](https://github.com/rescript-lang/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-lang/reanalyze).

`@live` tells reanalyze's dead code analysis that the value should be considered live, even though it might appear to be dead. This is typically used in case of FFI where there are indirect ways to access values.
It can be added to everything that could otherwise be considered unused by the dead code analysis - values, functions, arguments, records, individual record fields, and so on.

### References

- [Reanalyze: Controlling reports with Annotations](https://github.com/rescript-association/reanalyze#dce-controlling-reports-with-annotations)
- [Reanalyze: Controlling reports with Annotations](https://github.com/rescript-lang/reanalyze#dce-controlling-reports-with-annotations)
4 changes: 2 additions & 2 deletions misc_docs/syntax/decorator_raises.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ summary: "This is the `@raises` decorator."
category: "decorators"
---

> This decorator requires [`reanalyze`](https://github.com/rescript-association/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-association/reanalyze).
> This decorator requires [`reanalyze`](https://github.com/rescript-lang/reanalyze), a code analysis tool for ReScript, to be installed. [Click here to read about how you get started with reanalyze.](https://github.com/rescript-lang/reanalyze).

`@raises` is picked up by reanalyze's exception analysis, and acknowledges that a function can raise exceptions that are not caught, and suppresses a warning in that case. Callers of the functions are then subjected to the same rule. Example `@raises(Exn)` or `@raises([E1, E2, E3])` for multiple exceptions.

### References

- [Reanalyze: Exception Analysis](https://github.com/rescript-association/reanalyze/blob/master/EXCEPTION.md)
- [Reanalyze: Exception Analysis](https://github.com/rescript-lang/reanalyze/blob/master/EXCEPTION.md)
2 changes: 1 addition & 1 deletion pages/blogpost-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on rescript-lang.org.

## Requirements

Clone the [rescript-lang.org repo](https://github.com/rescript-association/rescript-lang.org) and follow the README instructions to run the local development server.
Clone the [rescript-lang.org repo](https://github.com/rescript-lang/rescript-lang.org) and follow the README instructions to run the local development server.

Open the [localhost:3000/blog](/blog) page to see the blog page.

Expand Down
6 changes: 3 additions & 3 deletions pages/community/roadmap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ For latest development updates, please check out the [ReScript forum](https://fo

Major v12.0 release (see [v12 milestone](https://github.com/rescript-lang/rescript-compiler/milestone/16)).

* Move the [Rescript Core](https://github.com/rescript-association/rescript-core) standard library into the compiler / remove the OCaml standard library
* A new build system tailored to ReScript's needs ([rewatch](https://github.com/teamwalnut/rewatch)) for better monorepo support and even faster compilation speed
* Make it easier to create libraries for consumption from TypeScript with GenType
- Move the [Rescript Core](https://github.com/rescript-lang/rescript-core) standard library into the compiler / remove the OCaml standard library
- A new build system tailored to ReScript's needs ([rewatch](https://github.com/teamwalnut/rewatch)) for better monorepo support and even faster compilation speed
- Make it easier to create libraries for consumption from TypeScript with GenType

**Note:** Release goals may be subject to change.
4 changes: 3 additions & 1 deletion pages/docs/guidelines/publishing-packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ canonical: "/guidelines/publishing-npm-packages"
Whenever you publish a ReScript package to npm, please follow the following guidelines:

**Naming:**

- Make sure to give a descriptive package name. We usually use `rescript-[name-of-js-lib]` for packages that bind to a specific JS library on npm.
- Use names that are self explanatory (no weird marketing terms / fantasy words if possible).

**Metadata:**

- Add a proper `description` field in your `package.json` file
- Add `rescript` as a keyword in your `package.json` file

Expand All @@ -26,4 +28,4 @@ Our package index will pick up the newest npm packages two times a day, so it mi

We also maintain a hand-curated index of different resources that are not necessarily released on npm, such as plain URLs to independent files / repositories, or GitHub gists.

You can submit your own resource by editing rescript-lang.org's [resource json file](https://github.com/rescript-association/rescript-lang.org/blob/master/data/packages_url_resources.json) file and submit a PR.
You can submit your own resource by editing rescript-lang.org's [resource json file](https://github.com/rescript-lang/rescript-lang.org/blob/master/data/packages_url_resources.json) file and submit a PR.
2 changes: 1 addition & 1 deletion pages/docs/manual/latest/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ canonical: "/docs/manual/latest/installation"

## Notes

With the instructions below, our new standard library [ReScript Core](https://github.com/rescript-association/rescript-core) will be included by default. (In ReScript 11, it comes as a separate npm package `@rescript/core`. In future versions, it will be included in the `rescript` npm package itself.)
With the instructions below, our new standard library [ReScript Core](https://github.com/rescript-lang/rescript-core) will be included by default. (In ReScript 11, it comes as a separate npm package `@rescript/core`. In future versions, it will be included in the `rescript` npm package itself.)

## Prerequisites

Expand Down
Loading