Add free_conversation usage example for generative_ai category#757
Add free_conversation usage example for generative_ai category#757himanshigaba22 wants to merge 4 commits into
Conversation
❌ Deploy Preview for splashkit failed.
|
himanshigaba22
force-pushed
the
free-conversation-usage-example
branch
from
7bec872 to
cb9f425
Compare
Osaid2993
left a comment
Osaid2993
left a comment
There was a problem hiding this comment.
This PR should be split. It currently combines two usage examples in one submission, which makes tracking harder and increases overlap. Please keep one usage example per PR and make sure there is a proper card for each one.
|
Hi, thank you for the feedback!
This PR only contains the free_conversation and free_all_conversations usage example — 6 files all in the generative_ai folder. The replace_all example is a completely separate PR (#704).
Could you please check the Files Changed tab? It only shows 6 files. Thank you!
Get Outlook for Mac <https://aka.ms/GetOutlookForMac>
From: Osaid2993 ***@***.***>
Date: Tuesday, 5 May 2026 at 7:45 pm
To: thoth-tech/splashkit.io-starlight ***@***.***>
Cc: HIMANSHI GABA ***@***.***>, Author ***@***.***>
Subject: Re: [thoth-tech/splashkit.io-starlight] Add free_conversation usage example for generative_ai category (PR #757)
@Osaid2993 requested changes on this pull request.
This PR should be split. It currently combines two usage examples in one submission, which makes tracking harder and increases overlap. Please keep one usage example per PR and make sure there is a proper card for each one.
—
Reply to this email directly, view it on GitHub<#757 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/BXC5ZF7SEZGBTCIWQCHDXLL4ZGZ2TAVCNFSM6AAAAACYRGKO2CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHM2DEMRWHEYDINJVG4>.
Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
I checked the files changed. The issue is not the 6 files. The issue is that the same usage example mixes two different functions, it starts with freeing individual conversations and then also shows freeing all remaining conversations, which is why I said it should be split. |
himanshigaba22
force-pushed
the
free-conversation-usage-example
branch
2 times, most recently
from
7bec872 to
d56370b
Compare
himanshigaba22
force-pushed
the
free-conversation-usage-example
branch
from
6c1ae96 to
d5b3d40
Compare
|
Hi! I have updated the example to only demonstrate the
free_conversation function. It now creates a single conversation
and frees it, without mixing in free_all_conversations.
Please let me know if anything else needs changing. Thank you!
Get Outlook for Mac <https://aka.ms/GetOutlookForMac>
From: Osaid2993 ***@***.***>
Date: Wednesday, 6 May 2026 at 3:23 pm
To: thoth-tech/splashkit.io-starlight ***@***.***>
Cc: HIMANSHI GABA ***@***.***>, Author ***@***.***>
Subject: Re: [thoth-tech/splashkit.io-starlight] Add free_conversation usage example for generative_ai category (PR #757)
[Image removed by sender.]Osaid2993 left a comment (thoth-tech/splashkit.io-starlight#757)<#757 (comment)>
I checked the files changed. The issue is not the 6 files. The issue is that the same usage example mixes two different functions, it starts with freeing individual conversations and then also shows freeing all remaining conversations, which is why I said it should be split.
—
Reply to this email directly, view it on GitHub<#757 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/BXC5ZFZHBQMI23F6WWLO7Y34ZLD5HAVCNFSM6AAAAACYRGKO2CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGOBVGM2TCNRZGY>.
Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
The updated usage example is now much clearer and stays focused on demonstrating a single function, which makes it easier for beginners to understand. The implementation across C++, C#, and Python also appears consistent and follows the usage example structure well. The comments are simple and explain the purpose of the code clearly without overcomplicating the example. Overall, this looks like a clean and beginner-friendly contribution to the generative_ai category. The remaining failing checks may just need to be resolved before the PR can be merged. |
There was a problem hiding this comment.
Hi @himanshigaba22 Thanks for the update. the code looks much better now and it is focused on free_conversation. However, the screenshot still shows the old output from the previous version. Please update the .png to match the current example output, then I’m happy approve it.
222448082Ashen
left a comment
222448082Ashen
left a comment
There was a problem hiding this comment.
Description
This PR adds a new usage example for the FreeConversation function within the generative_ai category. It provides consistent demonstrations across C++, C# (Top-level and OOP), and Python to show how to release AI conversation resources.
Type of change
- Documentation (update or new)
How Has This Been Tested?
The code examples were manually reviewed for syntax correctness and structural consistency across all supported languages. The file structure was verified against repository standards.
- Verified file structure in
public/usage-examples/generative_ai/ - Checked cross-language structural consistency
- npm run build (Failed in current environment due to unrelated script dependencies)
- npm run preview
Checklist
If involving code
- My code follows the style guidelines of this project
- I have performed a self-review of my own code
- I have commented my code in hard-to-understand areas
- I have made corresponding changes to the documentation
- My changes generate no new warnings
If modified config files
N/A (No config files modified)
Folders and Files Added/Modified
- Added:
-
public/usage-examples/generative_ai/free_conversation-1-example.cpp -
public/usage-examples/generative_ai/free_conversation-1-example-oop.cs -
public/usage-examples/generative_ai/free_conversation-1-example-top-level.cs -
public/usage-examples/generative_ai/free_conversation-1-example.py -
public/usage-examples/generative_ai/free_conversation-1-example.txt -
public/usage-examples/generative_ai/free_conversation-1-example.png
-
Additional Notes
The example is correctly isolated within the generative_ai folder. Note that the Python implementation uses snake_case (free_conversation) which is consistent with the library's convention for that language.
Thanks for the feedback, I have now updated the screenshot to match the current output of the simplified |
Hi! Thank you for the feedback. I have already split the example — The Files changed tab now shows only 6 files focused on |
himanshigaba22
left a comment
himanshigaba22
left a comment
There was a problem hiding this comment.
Hi! I have addressed both issues:
- Added
using SplashKitSDK;to the top-level C# file - Added the free_conversation entry to usage-example-references.json
under a new generative_ai section
Please let me know if anything else needs changing. Thank you!
Osaid2993
left a comment
Osaid2993
left a comment
There was a problem hiding this comment.
Peer Review
I've reviewed the free_conversation usage example PR.
Checks
-
All required files are present.
- Example Title (.txt)
- C++ code
- C# code (top-level statements)
- C# code (Object-Oriented Programming)
- Python code
-
Code correctly uses SplashKit functions.
-
Code clearly demonstrates the function.
-
All versions maintain the same structure and comments.
Code Tests done
- C++ code ran correctly.
- C# top level code ran correctly.
- C# OOP code ran correctly.
- Python code ran correctly.
Website Tests done
- npm run build
- npm run preview
The updated screenshot now matches the current example output, and the PR is focused on free_conversation. Nice work.
|
The PR looks good. All comments are been approved, I am happy to approve. Thank you. |
222448082Ashen
left a comment
222448082Ashen
left a comment
There was a problem hiding this comment.
All comments are been approved, I am happy to approve.
6 participants
Description
Added a usage example for the
free_conversationandfree_all_conversationsfunctions in the generative_ai category.The example demonstrates proper lifecycle management of AI conversation resources by:
create_conversation()free_conversation()free_all_conversations()Type of change
How Has This Been Tested?
The example output was verified manually to ensure conversations are correctly created and released.
Testing Checklist