Skip to content

Conversation

@BryanQuigley
Copy link
Member

Pulling two commits from upstream

the bigger issue one is timwis/jkan#292 which we may need to be careful it doesn't break our current flows. It will try to validate all links in a PR - and check spelling too.

Works can be added to cspell.json (there are also ways to just disable it or add works for certain files - https://cspell.org/docs/Configuration/document-settings)

It required the img links to not be root based /img/ -> img/. I'm not sure if that has other implications or not.

It is not currently performant enough to run the linter against our whole project (link checking), Hope to improve that over time.

Happy to wait if any other big updates want to land first - as this could require more work.

Improve Linting, spelling, links and better control script

this includes spellcheck for both other files and markdown
updated lint script that has more options - including formatting
enabled markdown link checker as the first pass on making sure links work
update CI to only activate on changed files
@BryanQuigley BryanQuigley force-pushed the upstream_cherry_pick branch 2 times, most recently from d6dc0a9 to 53657c5 Compare October 29, 2025 04:04
@BryanQuigley
Copy link
Member Author

Fixed the npm build, this is ready for review / discussion.

The spell checker can sometimes get annoying with names/organization names, but can be controlled on a per document level:
https://cspell.org/docs/Configuration/document-settings

We can see how it goes on the next few reviews?

Copy link
Collaborator

@lydiascarf lydiascarf 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! i'm excited about having link checks

@BryanQuigley BryanQuigley merged commit 61ba68b into main Nov 14, 2025
4 of 5 checks passed
@BryanQuigley BryanQuigley deleted the upstream_cherry_pick branch November 14, 2025 16:14
@BryanQuigley
Copy link
Member Author

Ty, merging, let's watch the next few PRs and see if it needs tweaking

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.

3 participants