Skip to content

Add Vale to documentation builds #677

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

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Add Vale to documentation builds #677

wants to merge 18 commits into from

Conversation

justinegeffen
Copy link
Contributor

@justinegeffen justinegeffen commented Jun 24, 2025

This PR introduces Vale to be used for:

  • Spelling errors
  • Header checking
  • Link checking (internal and external)
  • Updated word lists to include Seqera terminology
  • Removed Contractions.yml as we prefer not to use contractions in our content
  • Removed some terms from the word list

To be added:

  • A better way to identify where the errors are, line by line

Copy link

netlify bot commented Jun 24, 2025

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit 46a5628
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/6874ab0b1798fa000813146e
😎 Deploy Preview https://deploy-preview-677--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@justinegeffen justinegeffen added 1. Editor review Needs a language review do not merge Do not merge until this label is removed labels Jul 3, 2025
@christopher-hakkaart
Copy link
Member

I'm actively reviewing this. Something in my VS Code isn't working with Vale. I can see it working in the PR, but it's not clear why it's not working locally. I'll investigate as part of the review.

@justinegeffen
Copy link
Contributor Author

I'm actively reviewing this. Something in my VS Code isn't working with Vale. I can see it working in the PR, but it's not clear why it's not working locally. I'll investigate as part of the review.

I suspect it's something that Cursor AI might have done - I have deleted one possibly problematic file. LMK if there are still issues on your side.

Copy link
Member

@christopher-hakkaart christopher-hakkaart left a comment

Choose a reason for hiding this comment

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

It works for me locally again. The problems list can be overwhelming, however, I thing it's a huge net improvement and we can assess updating lists and turning things on and off once it's implemented. It's a go ahead from me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1. Editor review Needs a language review do not merge Do not merge until this label is removed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants