Skip to content
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

docs: Mention changelogCommitBodies and add IntelliJ schema settings guide #721

Merged
merged 4 commits into from
Jun 4, 2024

Conversation

mzdm
Copy link
Contributor

@mzdm mzdm commented Jun 2, 2024

Description

#606 changelogCommitBodies change is great, needed it badly so glad it exists, however is missing in the docs

I am regular IntelliJ user and having schema is a must have, so I added a small guide how to get it.

Btw the https://github.com/blaugold/melos-code/pulls repo has some PRs to review

Type of Change

  • feat -- New feature (non-breaking change which adds functionality)
  • 🛠️ fix -- Bug fix (non-breaking change which fixes an issue)
  • ! -- Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 refactor -- Code refactor
  • ci -- Build configuration change
  • 📝 docs -- Documentation
  • 🗑️ chore -- Chore

Copy link
Collaborator

@spydon spydon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just one small comment


### `melos.yaml`

Autocompletion and validation of `melos.yaml` can be enabled in IntelliJ by going to `Settings` > `Languages & Frameworks` > `Schemas and DTDs` > `JSON Schema Mappings` and adding the Melos schema:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you wrap this so that the line length is <80?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍

@mzdm mzdm requested a review from spydon June 4, 2024 12:35
### `melos.yaml`

Autocompletion and validation of `melos.yaml` can be enabled in IntelliJ by going to
`Settings` > `Languages & Frameworks` > `Schemas and DTDs` > `JSON Schema Mappings` and adding the Melos schema:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still longer than 80

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, true

@mzdm mzdm requested a review from spydon June 4, 2024 13:27
@spydon spydon changed the title docs: add missing mention about changelogCommitBodies, add IntelliJ schema settings guide docs: Mention changelogCommitBodies and add IntelliJ schema settings guide Jun 4, 2024
Copy link
Collaborator

@spydon spydon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@spydon spydon enabled auto-merge (squash) June 4, 2024 15:54
@spydon spydon merged commit 49e7d4c into invertase:main Jun 4, 2024
11 checks passed
@mzdm
Copy link
Contributor Author

mzdm commented Jun 5, 2024

I've noticed the images does not get shown, I guess mdx does not support img directly. However the base images take a lot of space so I will resubmit smaller ones.

Is there a way by the way to build the docs locally? I did not find a way

@spydon

@spydon
Copy link
Collaborator

spydon commented Jun 5, 2024

I've noticed the images does not get shown, I guess mdx does not support img directly. However the base images take a lot of space so I will resubmit smaller ones.

Is there a way by the way to build the docs locally? I did not find a way

@spydon

Ah, I missed this, you can preview your changes on https://melos.invertase.dev/~721

https://use.docs.page/previews#custom-domain

@mzdm
Copy link
Contributor Author

mzdm commented Jun 5, 2024

I've noticed the images does not get shown, I guess mdx does not support img directly. However the base images take a lot of space so I will resubmit smaller ones.
Is there a way by the way to build the docs locally? I did not find a way
@spydon

Ah, I missed this, you can preview your changes on https://melos.invertase.dev/~721

https://use.docs.page/previews#custom-domain

Thx, I'll add it to Contributing.md guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants