chore: added codespell

[ezhil56x]

Added check spelling in ci-docs.yml

Closes #805

[coderabbitai]

Walkthrough

The newly added GitHub Actions workflow in the .github/workflows/ci-docs.yml file ensures automated documentation building and spelling checks for markdown files. This change aims to enhance the quality and consistency of the repository's documentation.

Changes

File Path	Change Summary
.github/.../ci-docs.yml	Introduced a workflow for building docs and spell check

Assessment against linked issues

Objective	Addressed	Explanation
Add a spell check in lint and CI (#805)	✅

The addition of the spell check in the continuous integration process directly addresses the primary objective of issue #805, ensuring no spelling errors in the documentation, thus maintaining a professional standard.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

[coderabbitai]

Consider narrowing the scope of the push trigger to branches that typically receive documentation updates (e.g., main, develop) to avoid unnecessary workflow runs.

[coderabbitai]

Review the directories listed in the skip option to ensure no relevant directories are inadvertently excluded from spell checks. Consider removing .github and .vscode from the skip list if they contain significant textual content that should be spell-checked.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.89%. Comparing base (b99849e) to head (d343220).

❗ Current head d343220 differs from pull request most recent head e3d2bb3. Consider uploading reports for the commit e3d2bb3 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1832      +/-   ##
==========================================
- Coverage   86.89%   86.89%   -0.01%     
==========================================
  Files         156      156              
  Lines       15829    15829              
==========================================
- Hits        13755    13754       -1     
- Misses       2074     2075       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.