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

fix spelling in docs, code comments, strings & non-exported names #1983

Merged
merged 28 commits into from
Nov 23, 2024

Conversation

cr7pt0gr4ph7
Copy link
Contributor

@cr7pt0gr4ph7 cr7pt0gr4ph7 commented Nov 23, 2024

Fixed all spelling issues that I could find (using an automated spell checker to find the issues, resolution was always chosen manually). I have explicitly excluded exported names/functions from this PR (even those that are only intended for use within Vike itself) to avoid any possible breakages, those can currently be found in the cr7pt0gr4ph7/vike:fix-spelling-public branch and will follow in a second PR.

docs/pages/Head/+Page.mdx Outdated Show resolved Hide resolved
docs/pages/eject/+Page.mdx Outdated Show resolved Hide resolved
@brillout
Copy link
Member

Very nice! Although, to avoid merge conflicts, let's revert the typo fixes in the source code (i.e. inside the vike/ directory).

@brillout
Copy link
Member

FYI #1943.

using an automated spell checker

Which one did you use? CC @IanWorley

@brillout brillout merged commit 5d2f02d into vikejs:main Nov 23, 2024
17 checks passed
@brillout
Copy link
Member

I went ahead and applied the changes and merged. Thank you! Contribution welcome to #1943.

@IanWorley
Copy link

IanWorley commented Nov 23, 2024

FYI #1943.

using an automated spell checker

Which one did you use? CC @IanWorley

As of right now I went ahead and decide to use typos-rs-npm @brillout

@cr7pt0gr4ph7
Copy link
Contributor Author

cr7pt0gr4ph7 commented Nov 23, 2024

Very nice! Although, to avoid merge conflicts, let's revert the typo fixes in the source code (i.e. inside the vike/ directory).

These were the main goal of this PR, also fixing up the docs was just an add-on 😅 (Cause they were annoying me while debugging something...). Any chance to get at least the spelling fixes for comments & user-facing strings in?

@cr7pt0gr4ph7
Copy link
Contributor Author

All merge conflicts should be easily fixable though, because there are no renames that affect multiple files at once in this PR, only local renames.

(And if it is decided to a spell checker in CI, most/all of these would have to be fixed anyway at some point - so better fix them now IMO).

@brillout
Copy link
Member

We plan to merge all pending work, so that we'll have 0 pending PRs and 0 pending branches. We'll then be able to do it.

But it's going to take a little while as we're currently focusing on a couple of higher priorities. Very much looking forward to get Vike's backlog completely done.

The merge conflicts are really annoying, so I'm fairly convinced it's worth it to postpone it.

That said, you can still effectively contribute by contributing to the upcoming spellcheck CI, if you're up for it.

(And if it is decided to a spell checker in CI, most/all of these would have to be fixed anyway at some point - so better fix them now IMO).

The CI will only apply to docs/ for now.

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