Add playground documentation to navigation#416
Conversation
- Updated `mint.json` to include the "playground" page in the documentation navigation - Positioned under the "Other Features" group for easy access
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request adds a "playground" page to the documentation, providing an interactive environment for users to test and run AI Agents. It includes updating the mint.json file to include the new page in the navigation under the "Other Features" group, and creating a new playground.mdx file with the content for the playground, including an embedded iframe for code execution and links to the API documentation and course.
Highlights
- Documentation Update: The
mint.jsonfile is updated to include the 'playground' page in the documentation navigation, making it easily accessible under the 'Other Features' group. - New Playground Page: A new
playground.mdxfile is created, which includes an iframe that embeds a code execution environment, allowing users to test and run AI Agents directly from the documentation. - Interactive Environment: The playground provides a pre-loaded code editor with a simple example, instructions on how to use it, and links to relevant resources like the API documentation and the AI Agents course.
Changelog
- docs/mint.json
- Added 'playground' to the list of pages under the 'Other Features' group in the documentation navigation.
- docs/playground.mdx
- Created a new page with a title, sidebar title, description, and icon.
- Embedded an iframe to host the code execution environment.
- Added instructions on how to use the playground.
- Included links to the API documentation and the AI Agents course.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Trivia time!
What company developed the gpt-3.5-turbo model used in the playground's example code?
Click here for the answer
OpenAI developed the gpt-3.5-turbo model.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a "playground" page to the documentation navigation, providing an interactive environment for users to test and run AI Agents. The changes are straightforward and seem well-implemented.
Merge Readiness
The pull request appears to be well-implemented and ready for merging. The addition of the playground documentation enhances the user experience by providing a convenient way to test and experiment with AI Agents. I am unable to directly approve the pull request, and other reviewers should review and approve this code before merging.
|
|
||
| <iframe | ||
| id="codeExecutionFrame" | ||
| src="https://code-execution-server-praisonai.replit.app/?code=import%20openai%0A%0Aclient%20%3D%20openai.OpenAI()%0Aresult%20%3D%20client.chat.completions.create(%0A%20%20%20%20model%3D%22gpt-3.5-turbo%22%2C%0A%20%20%20%20messages%3D%5B%0A%20%20%20%20%20%20%20%20%7B%22role%22%3A%20%22user%22%2C%20%22content%22%3A%20%22Hello%20World%22%7D%0A%20%20%20%20%5D%0A)%0A%0Aprint(result.choices%5B0%5D.message.content)" |
There was a problem hiding this comment.
The URL in the src attribute is quite long and includes encoded characters. While this is functional, consider if there's a way to simplify this, perhaps by moving the initial code to a separate file and referencing it, or by using a more readable format for the URL parameters. This would improve maintainability.
| frameborder="0" | ||
| allow="clipboard-read; clipboard-write" | ||
| scrolling="yes" | ||
| onload="resizeIframe(this)" |
There was a problem hiding this comment.
It's good practice to include a fallback mechanism or message in case the iframe fails to load or the external resource is unavailable. Consider adding a simple error message or a link to a troubleshooting guide within a <noscript> tag or using JavaScript to detect iframe load failures.
✅ Deploy Preview for praisonai ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Add playground documentation to navigation
1 participant
mint.jsonto include the "playground" page in the documentation navigation