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: reorganize documentation for v2 and v3 versions #1505

Merged
merged 4 commits into from
Jan 7, 2025

Conversation

gdcsinaptik
Copy link
Collaborator

@gdcsinaptik gdcsinaptik commented Jan 7, 2025

Documentation Versioning

This PR reorganizes the documentation to support proper versioning between v2 and v3.

Changes

  • Moved documentation files into v2 and v3 folders
  • Updated mint.json navigation to properly handle versioned content
  • Fixed file references in navigation to match the new structure
  • Removed references to non-existent files

Testing

  • Verified that version toggle works correctly
  • Confirmed all documentation files are accessible
  • Tested local preview with mintlify dev

Important

Reorganize documentation for v2 and v3, updating structure and navigation for versioning support.

  • Documentation Structure:
    • Moved documentation files into v2 and v3 folders for versioning.
    • Updated mint.json to handle versioned content, including navigation updates.
  • File References:
    • Fixed file references in navigation to match new structure.
    • Removed references to non-existent files.
  • Testing:
    • Verified version toggle functionality.
    • Confirmed accessibility of all documentation files.
    • Tested local preview with mintlify dev.

This description was created by Ellipsis for 36de631. It will automatically update as commits are pushed.

@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Jan 7, 2025
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to af3ee71 in 1 minute and 53 seconds

More details
  • Looked at 3263 lines of code in 40 files
  • Skipped 0 files when reviewing.
  • Skipped posting 5 drafted comments based on config settings.
1. docs/v2/advanced-security-agent.mdx:8
  • Draft comment:
    Consider adding 'a' before 'query' for grammatical correctness: '...to identify if a query can generate malicious code.'
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The sentence in line 8 of docs/v2/advanced-security-agent.mdx is missing an article before 'query'. It should be 'a query'.
2. docs/v2/connectors.mdx:6
  • Draft comment:
    Consider adding 'The' before 'mission' for grammatical correctness: 'The mission of PandasAI is to make data analysis...'
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The sentence in line 6 of docs/v2/connectors.mdx is missing an article before 'mission'. It should be 'The mission'.
3. docs/v2/custom-response.mdx:18
  • Draft comment:
    Consider changing 'behaviour' to 'behavior' for consistency with American English spelling.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In docs/v2/custom-response.mdx, line 18, the word 'behaviour' is spelled in British English. To maintain consistency, it should be 'behavior' in American English.
4. docs/v2/skills.mdx:29
  • Draft comment:
    Consider rephrasing to: 'Function docstring to provide more context to the model for using this skill'.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In docs/v2/skills.mdx, line 29, the phrase 'Function doc string to give more context to the model for use this skill' is awkward. It should be 'Function docstring to provide more context to the model for using this skill'.
5. docs/v2/train.mdx:149
  • Draft comment:
    Consider changing 'generated' to 'generate' for correct tense usage: 'First of all, you'll need to generate an API key...'
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In docs/v2/train.mdx, line 149, 'generated' should be 'generate' to maintain the correct tense.

Workflow ID: wflow_p7M5JJcRJcy9vFJZ


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

docs/v3/getting-started.mdx Outdated Show resolved Hide resolved
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on f5dc417 in 41 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/v3/getting-started.mdx:65
  • Draft comment:
# read csv - replace "filepath" with your file path
df = pandasai.read_csv("filepath")
  • Reason this comment was not posted:
    Comment did not seem useful.

Workflow ID: wflow_KxQkZUnOK8QEFLZV


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Incremental review on 36de631 in 1 minute and 53 seconds

More details
  • Looked at 2286 lines of code in 22 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 drafted comments based on config settings.
1. docs/mint.json:43
  • Draft comment:
    The PR description mentions updating the mint.json navigation for versioning, but the diff does not show any changes related to navigation updates for versioning. Please ensure that the navigation is correctly updated to reflect the new documentation structure.
  • Reason this comment was not posted:
    Comment did not seem useful.
2. docs/v2/connectors.mdx:6
  • Draft comment:
    Consider adding 'The' before 'PandasAI mission' for grammatical correctness.
The PandasAI mission is to make data analysis and manipulation more efficient and accessible to everyone. This includes making it easier to connect to data sources and to use them in your data analysis and manipulation workflow.
  • Reason this comment was not posted:
    Comment was on unchanged code.
3. docs/v2/connectors.mdx:20
  • Draft comment:
    Consider rephrasing to: 'Watch the video on how to use the connectors:'
Watch the video on how to use the connectors:
  • Reason this comment was not posted:
    Comment was on unchanged code.
4. docs/v2/intro.mdx:6
  • Draft comment:
    Consider adding 'The' before 'PandasAI mission' for grammatical correctness.
The PandasAI mission is to make data analysis and manipulation more efficient and accessible to everyone. This includes making it easier to connect to data sources and to use them in your data analysis and manipulation workflow.
  • Reason this comment was not posted:
    Marked as duplicate.
5. docs/v2/intro.mdx:20
  • Draft comment:
    Capitalize 'python' to 'Python' for consistency.
PandasAI uses a generative AI model to understand and interpret natural language queries and translate them into Python code and SQL queries. It then uses the code to interact with the data and return the results to the user.
  • Reason this comment was not posted:
    Comment was on unchanged code.
6. docs/v2/library.mdx:6
  • Draft comment:
    Consider adding 'The' before 'PandasAI mission' for grammatical correctness.
The PandasAI mission is to make data analysis and manipulation more efficient and accessible to everyone. This includes making it easier to connect to data sources and to use them in your data analysis and manipulation workflow.
  • Reason this comment was not posted:
    Marked as duplicate.
7. docs/v2/semantic-agent.mdx:6
  • Draft comment:
    Consider adding 'The' before 'PandasAI mission' for grammatical correctness.
The PandasAI mission is to make data analysis and manipulation more efficient and accessible to everyone. This includes making it easier to connect to data sources and to use them in your data analysis and manipulation workflow.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_tzZCoRIDeu8f0ja3


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

docs/v2/library.mdx Outdated Show resolved Hide resolved
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
@gventuri gventuri merged commit cc7db24 into release/v3 Jan 7, 2025
0 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants