Skip to content

Commit

Permalink
docs: Fix intellij image docs links, update CONTRIBUTING guide (#723)
Browse files Browse the repository at this point in the history
* docs: intellij image docs links

* remove empty lines

* fix url

* Update CONTRIBUTING.md

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

---------

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>
  • Loading branch information
mzdm and spydon authored Jun 17, 2024
1 parent 6ffa8b3 commit 6c0b95b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Melos is a tool that optimizes the workflow around managing multi-package reposi

- If you have suggestions for improvements to the documentation or examples (or something else), we would love to hear about it.
- As always first file a [GitHub issue](https://github.com/invertase/melos/issues/new).
- Implement the changes to the documentation, please read the [How To](#how-to-contribute).
- Implement the changes to the documentation, please read the [Docs](#docs) section.

## How To Contribute

Expand Down Expand Up @@ -82,6 +82,14 @@ melos --help
- Push your new branch to your own fork into the same remote branch
(e.g. `git push origin my-username.my-new-feature`, replace `origin` if you use another remote.)

### Docs

When editing the documentation, once you have submitted your Pull Request (PR)
and pipeline has passed, you can preview your changes on:
https://melos.invertase.dev/~{PR_NUMBER}.
- For example a PR with number 123, you can preview on: https://melos.invertase.dev/~123
- For more information, see the [docs.page documentation](https://use.docs.page/previews#custom-domain).

### Open a pull request

To send us a pull request:
Expand All @@ -96,4 +104,3 @@ guide.

Please also enable **“Allow edits by maintainers”**, this will help to speed-up the review
process as well.

Binary file modified docs/assets/intellij-run-configurations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/intellij-schema-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/ide-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Melos will create an IntelliJ project module for each package in your Melos
workspace, and will create flutter and dart Run configurations for your
`main.dart`s and your package's test suite.

<img src="/assets/intellij-run-configurations.png" alt="Generated Run configurations" height="600"/>
![Generated Run configurations](/assets/intellij-run-configurations.png)

### `melos.yaml`

Expand All @@ -28,7 +28,7 @@ going to `Settings` > `Languages & Frameworks` > `Schemas and DTDs` >
- Schema version: JSON Schema version 7
- File: Select `melos.yaml`

<img src="/assets/intellij-schema-settings.png" alt="Schema settings" width="800"/>
![Schema settings](/assets/intellij-schema-settings.png)

## VS Code

Expand Down

0 comments on commit 6c0b95b

Please sign in to comment.