FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

First draft AI guide #1157

Closed meritmalling closed 6 days ago

meritmalling commented 1 week ago

WIP! Getting basics up so we can iterate

coderabbitai[bot] commented 1 week ago

Walkthrough

A new file, guides/ai.mdx, has been introduced, providing a detailed guide on utilizing Flatfile's AI Assist feature for effective and accurate bulk data edits through natural language commands. This guide covers various functionalities such as combining data, calculating values, extracting data, moving and modifying data, and includes features like filtering, prompting, previewing changes, iterative prompting, version history, and data privacy.

Changes

Files Change Summary
guides/ai.mdx Introduces a comprehensive guide on leveraging AI transformations with Flatfile's AI Assist feature for efficient bulk data edits using natural language commands. The guide covers a wide range of functionalities and additional features to enhance user experience.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Flatfile
    participant AI_Assist

    User ->> Flatfile: Upload Data
    Flatfile ->> AI_Assist: Initiate AI Transformation
    AI_Assist ->> User: Prompt for Natural Language Command
    User ->> AI_Assist: Provide Command
    AI_Assist ->> Flatfile: Process Command and Transform Data
    Flatfile ->> User: Show Preview of Changes
    User ->> Flatfile: Confirm Changes
    Flatfile ->> AI_Assist: Apply Confirmed Changes
    AI_Assist ->> Flatfile: Finalize Data Transformation
    Flatfile ->> User: Display Updated Data

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 33d74cf7db58b2ef69093f38d035fe3769399466 and c38eacec52f40c257de69d5cf4edc2a42fdb671a.
Files ignored due to path filters (1) * `mint.json` is excluded by `!**/*.json`
Files selected for processing (1) * guides/ai.mdx (1 hunks)
Additional context used
LanguageTool
guides/ai.mdx
[grammar] ~9-~9: A verb may be missing. (THIS_MISSING_VERB) Context: ...tively using natural language commands. This no code approach allows you to easily t...
Additional comments not posted (4)
guides/ai.mdx (4)
`9-9`: **Consider changing "no code" to "no-code" for consistency and clarity.** The phrase "no code" might be more accurately described as "no-code" to align with common terminology in the tech industry, enhancing readability and understanding.
Tools
LanguageTool
[grammar] ~9-~9: A verb may be missing. (THIS_MISSING_VERB) Context: ...tively using natural language commands. This no code approach allows you to easily t...
--- `92-92`: **Correct typographical error in the word "suggestions."** There's a minor typo in the Info block which could be corrected for clarity. --- `16-58`: **Well-detailed sections on AI Assist capabilities.** The sections on combining data, calculating values, extracting data, and modifying data are clear and provide valuable examples to guide the user. --- `72-125`: **Comprehensive explanation of AI Assist features.** The detailed descriptions of features like filtering, prompt suggestions, preview capabilities, iterative updates, version history, and data privacy are informative and well-structured.
---
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.