docs: Remove unsupported event from docs

[ncronquist]

No description provided.

[coderabbitai]

Walkthrough

The primary change involves modifying the event type check within the flatfile platform. The event type has been updated from 'job:started' to 'job:ready', which affects the logic flow based on these event types. This change enhances the system's response to different job statuses, ensuring more accurate handling of job readiness.

Changes

Files	Change Summary
.../flatfile/platform/...	Updated event type check from 'job:started' to 'job:ready' to adjust the logic flow based on event types.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Platform
    participant JobManager

    User->>Platform: Initiate Job
    Platform->>JobManager: Check Job Status
    JobManager-->>Platform: job:ready
    Platform-->>User: Job is Ready

Loading

This diagram illustrates the updated flow where the Platform now checks for the job:ready event type instead of job:started, and responds accordingly.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f4a1e5c and a462234.

Files selected for processing (1)

• README.md (1 hunks)

Additional context used

LanguageTool

README.md

[typographical] ~130-~130: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ...have to be moved over to our generation code, otherwise they would be overwritten upon the next...

---

[style] ~130-~130: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. (FEEL_FREE_TO_STYLE_ME)
Context: ...ritten upon the next generated release. Feel free to open a PR as a proof of concept, but kn...

Markdownlint

README.md

97-97: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

---

14-14: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Additional comments not posted (2)

README.md (2)

104-104: The update from 'job:started' to 'job:ready' aligns with the PR objectives and ensures consistency with the new event handling logic.

---

Line range hint 130-130: The phrase "feel free to" appropriately conveys an inviting tone for contributions; no change needed here.

---

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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: 0

Outside diff range and nitpick comments (3)

README.md (3)

Line range hint 130-130: Consider adding a comma after "otherwise" to improve readability.

- ...have to be moved over to our generation code, otherwise they would be overwritten upon the next...
+ ...have to be moved over to our generation code, otherwise, they would be overwritten upon the next...

---

Line range hint 97-97: Remove the extra blank line to maintain a clean and professional appearance in the documentation.

-

---

Line range hint 14-14: Specify the language for the fenced code block to enable syntax highlighting and improve readability.

- ```
+ ```bash