docs(website): add 'Getting Started' section
MODIFY
.github/ISSUE_TEMPLATE/01_bug.yml
.github/ISSUE_TEMPLATE/01_bug.yml
@@ -15,7 +15,7 @@ body:
id: environment
attributes:
label: Environment information
- description: Please share any information about your environment that can help debug your issue.
+ description: Please share any information about your environment that can help debug your issue (OS and OS version, CPU architecture, installation method, etc.).
render: bash
validations:
required: true
@@ -39,12 +39,6 @@ body:
placeholder: It should not throw an error.
validations:
required: true
- - type: textarea
- id: configuration
- attributes:
- label: Configuration file of your project
- description: Paste here your configuration if relevant
- render: json
- type: checkboxes
id: terms
attributes:

DELETE
website/src/_includes/docs/_old_getting-started.md
-## Getting Started
-
-### Installation and Usage
-
-#### [Yarn](https://yarnpkg.com/)
-
-```bash
-yarn add rome
-yarn rome init
-```
-
-#### [npm/npx](https://www.npmjs.com/)
-
-```bash
-npx rome init
-```
-
-After running this command, Rome will:
-
-- Add itself to `package.json` as dependency if it wasn't present, and run your package manager to install
-- Generate `rome.json` that serves as your project config.
-
-If you're putting Rome into an already established project and you'd like to automatically apply formatting and fixes, you can use:
-
-```bash
-npx rome init --apply
-```
-
-Refer to [Project Configuration](#project-configuration) for configuration options.
-
-### Start Linting
-
-You can now run Rome commands! Linting can be accessed via the command:
-
-```bash
-npx rome check
-```
-
-Continue to the next section to learn more about linting in Rome!

MODIFY
website/src/_includes/docs/formatter.md
website/src/_includes/docs/formatter.md
@@ -28,6 +28,11 @@ This is an **opt-in feature** that allows the developers to experiment how a for
> WARNING: all options are marked as **BETA** because this might change, once we will add support of a configuration file
+If you want to set Rome formatter as your default formatter, you can do so by opening the [command palette]
+and select `Format Document With ...` , then `Configure Default Formatter` and finally select `Rome`. The option will
+appear only for documents that Rome supports.
+
+
### Use the formatter with the CLI
The only command that is supported is `format`.
@@ -129,3 +134,6 @@ const expr = [
```
As you can see the first array, which has a suppression comment, is left untouched!
+
+
+[command palette]: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette
\ No newline at end of file

ADD
website/src/_includes/docs/getting-started.md
+## Getting Started
+
+Rome works on Linux, macOS, and Windows operative systems.
+
+On macOS, Linux and Windows we both support x64 and ARM architectures.
+
+Install Rome using any of the following installation methods.
+
+### Install Rome official VS Code extension
+
+You can use Rome by installing the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=rome.rome) from the marketplace.
+
+Rome currently doesn't support other editors than VS Code. Let us know if you're interested in getting support for another editor to help us prioritize our work.
+
+### Install Rome CLI
+
+Install `rome` using your preferred node package manager.
+
+> RECOMMENDATION: we advise to **not** install the binary globally, instead install the binary
+> locally to your project or use `npx/pnpx/yarn dlx` in order to leverage the CLI.
+
+
+| Package manager | Instructions |
+|-------------------------------|----------------------|
+| [npm](https://www.npmjs.com/) | `npm i rome@next` |
+| [pnpm](https://pnpm.io/) | `pnpm i rome@next` |
+| [yarn](https://yarnpkg.com/) | `yarn add rome@next` |
+
+
+### Install Rome in your CI pipeline
+
+#### GitHub Actions
+
+Please refer to the documentation of the [`setup-rome` action](https://github.com/rome/setup-rome#usage) for more information about its configuration:
+
+```yaml
+steps:
+ - uses: rome/setup-rome@v0.1
+ with:
+ version: latest
+ - run: rome --help
+```
+
+#### Installation on any other CI
+
+You can download and install the binary directly using `curl`:
+
+```shell
+curl -L https://github.com/rome/tools/releases/download/latest/rome-<OS>-<ARCH> -o rome
+chmod +x rome
+```
+
+Where `OS` and `ARCH` follow the Node.js syntax convention:
+
+- `OS` is one of the following values: `win32`, `darwin` or `linux`
+- `ARCH` is one of the following values: `arm64` or `x64`
+
+
+| | `win32` | `darwin` | `linux` |
+|---------|---------------|----------------|---------------|
+| `arm64` | `win32-arm64` | `darwin-arm64` | `linux-arm64` |
+| `x64` | `win32-x64` | `darwin-x64` | `linux-x64` |
+
+Please make sure to choose the correct architecture from the [releases page](https://github.com/rome/tools/releases).
+
+
+## After installation
+
+- check the [formatter section](/formatter#use-the-formatter-with-the-cli) for options and commands;
+- check the options available in the [VS Code extension](/formatter#use-the-formatter-with-the-vscode-extension)
+
+

MODIFY
website/src/index.md
website/src/index.md
@@ -5,6 +5,7 @@ layout: layouts/homepage.liquid
# The Rome Toolchain
{% include docs/intro.md %}
+{% include docs/getting-started.md %}
{% include docs/status.md %}
{% include docs/formatter.md %}
{% include docs/philosophy.md %}

docs(website): add 'Getting Started' section (#2320)

Co-authored-by: Micha Reiser <micha@rome.tools>