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: Fix spelling mistakes #969

Merged
merged 1 commit into from
Aug 7, 2024

Conversation

charlieegan3
Copy link
Member

There were a number of spelling mistakes in the documentation. This PR fixes them as the spelling will soon be enforced in docs.styra.com.

Copy link
Member

@anderseknert anderseknert left a comment

Choose a reason for hiding this comment

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

Thanks a lot! Would it not make sense to run the same spell checker in this repo? That way we'd be able to catch mistakes where they happen. But of course, not blocking.

There were a number of spelling mistakes in the documentation. This
PR fixes them as the spelling will soon be enforced in docs.styra.com.

Signed-off-by: Charlie Egan <[email protected]>
@anderseknert anderseknert merged commit 086cb25 into StyraInc:main Aug 7, 2024
3 checks passed
@charlieegan3
Copy link
Member Author

Indeed, I would like to have a spell checker here too. I think the way to go is to not check the regal spelling in docs.styra.com eventually and check here instead. I have a think about the best way to do it.

@charlieegan3 charlieegan3 deleted the fix-spellings branch August 7, 2024 12:29
@anderseknert
Copy link
Member

Inspires me to think about spell checking as a Regal linter rule too :) Might be some good Go library for that we could turn into a custom function, and then have at least an optional rule that could spell check comments, metadata or even code if desired.

@charlieegan3
Copy link
Member Author

💯 checking spelling in comments would be great.

srenatus pushed a commit to srenatus/regal that referenced this pull request Oct 1, 2024
There were a number of spelling mistakes in the documentation. This
PR fixes them as the spelling will soon be enforced in docs.styra.com.

Signed-off-by: Charlie Egan <[email protected]>
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