Updated readme, docs, notebooks

[gdcsinaptik]

Important

This pull request updates documentation and examples for PandaAI, reflecting new features and usage instructions, and removes outdated examples.

• Documentation:
  • Updated README.md to reflect new usage instructions and features.
  • Updated docs/mint.json to adjust navigation and links.
  • Updated docs/v3/agent.mdx, docs/v3/ai-dashboards.mdx, docs/v3/getting-started.mdx, docs/v3/large-language-models.mdx, docs/v3/output-formats.mdx, docs/v3/overview-nl.mdx, docs/v3/permission-management.mdx, docs/v3/share-dataframes.mdx with new instructions and features.
• Examples:
  • Removed outdated examples from examples/ directory.
  • Added new example data file heart.csv in examples/data/.
• Misc:
  • Updated Discord link in README.md.

^{This description was created by for 1e500e5. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 8de8cc5 in 1 minute and 19 seconds

More details

• Looked at 2123 lines of code in 35 files
• Skipped 8 files when reviewing.
• Skipped posting 9 drafted comments based on config settings.

1. docs/v3/agent.mdx:11

• Draft comment:
  The URL for signing up for the API key has been updated to https://app.pandabi.ai. Ensure this is the correct and intended change.
• Reason this comment was not posted:
  Confidence changes required: 10%
  The link to the API key signup page has been updated to a new URL. This change is consistent across multiple files.

2. README.md:18

• Draft comment:
  The deployment section has been removed. Ensure that this is intentional and that users have access to deployment instructions elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the deployment section, which might be intentional to simplify the document. However, it's important to ensure that users still have access to deployment instructions if needed.

3. README.md:42

• Draft comment:
  The demo section has been removed. Ensure that this is intentional and that users have access to demo instructions elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the demo section, which might be intentional to simplify the document. However, it's important to ensure that users still have access to demo instructions if needed.

4. README.md:57

• Draft comment:
  The section on running the platform has been removed. Ensure that this is intentional and that users have access to these instructions elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the section on running the platform, which might be intentional to simplify the document. However, it's important to ensure that users still have access to these instructions if needed.

5. README.md:97

• Draft comment:
  The demo link has been removed. Ensure that this is intentional and that users have access to demo resources elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the demo link, which might be intentional to simplify the document. However, it's important to ensure that users still have access to demo resources if needed.

6. README.md:110

• Draft comment:
  The section on saving and loading dataframes has been removed. Ensure that this is intentional and that users have access to these instructions elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the section on saving and loading dataframes, which might be intentional to simplify the document. However, it's important to ensure that users still have access to these instructions if needed.

7. README.md:137

• Draft comment:
  The section on sharing dataframes has been removed. Ensure that this is intentional and that users have access to these instructions elsewhere if needed.
• Reason this comment was not posted:
  Confidence changes required: 20%
  The README file has been updated to remove the section on sharing dataframes, which might be intentional to simplify the document. However, it's important to ensure that users still have access to these instructions if needed.

8. README.md:11

• Draft comment:
  Minor grammar issue. Suggestion:

PandaAI is a Python platform that makes it easy to ask questions to your data in natural language. It helps non-technical users to interact with their data in a more natural way, and it helps technical users to save time and effort when working with data.

• Reason this comment was not posted:
  Confidence changes required: 50%
  The sentence in line 11 of README.md has a minor grammar issue. The phrase "to save time, and effort" should not have a comma before "and."

9. docs/v3/agent.mdx:11

• Draft comment:
  Minor grammar issue. Suggestion:

Before you start training PandaAI, you need to set your PandaAI API key. You can generate your API key by signing up at the website [https://app.pandabi.ai](https://app.pandabi.ai).

• Reason this comment was not posted:
  Confidence changes required: 50%
  The sentence in line 11 of docs/v3/agent.mdx has a minor grammar issue. The phrase "by signing up at" should be followed by "the website" for clarity.

Workflow ID: wflow_BO22FCxEMgbUFltS

---

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

[ellipsis-dev]

❌ Changes requested. Incremental review on 8922785 in 42 seconds

More details

• Looked at 27 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 1 drafted comments based on config settings.

1. README.md:23

• Draft comment:
  Add a period at the end of the sentence.

Load your data, save them as a dataframe, and push them to the platform.

• Reason this comment was not posted:
  Confidence changes required: 50%
  The sentence on line 23 is missing a period at the end.

Workflow ID: wflow_txc9DtcrM3xZBG93

---

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.

[ellipsis-dev]

👍 Looks good to me! Incremental review on 1e500e5 in 22 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. README.md:75

• Draft comment:
  The URL change from https://pandabi.ai to https://app.pandabi.ai is correct and reflects the updated domain structure.
• Reason this comment was not posted:
  Confidence changes required: 0%
  The change in the URL is correct and aligns with the current domain structure.

Workflow ID: wflow_vvNxVouwGXQ1Ev6i

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.64%. Comparing base (63e8c26) to head (6320b3f).
Report is 125 commits behind head on release/v3.

Additional details and impacted files

@@              Coverage Diff               @@
##           release/v3    #1522      +/-   ##
==============================================
- Coverage       79.09%   76.64%   -2.45%     
==============================================
  Files             149       59      -90     
  Lines            6013     1884    -4129     
==============================================
- Hits             4756     1444    -3312     
+ Misses           1257      440     -817     

Flag	Coverage Δ
unittests	76.64% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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